awssolutionsconstructsawseventbridgesns

README

aws-eventbridge-sns module

---

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_eventbridge_sns
Typescript	@aws-solutions-constructs/aws-eventbridge-sns
Java	software.amazon.awsconstructs.services.eventbridgesns

This AWS Solutions Construct implements an AWS Events rule and an AWS SNS Topic.

Here is a minimal deployable pattern definition in Typescript:

import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventbridgeToSnsProps, EventbridgeToSns } from "@aws-solutions-constructs/aws-eventbridge-sns";

const props: EventbridgeToSnsProps = {
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5)),
    }
};

const constructStack = new EventbridgeToSns(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
    actions: ["kms:Encrypt", "kms:Decrypt"],
    effect: iam.Effect.ALLOW,
    principals: [ new iam.AccountRootPrincipal() ],
    resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer

new EventbridgeToSns(scope: Construct, id: string, props: EventbridgeToSnsProps);

Parameters

• scope Construct
• id string
• props EventbridgeToSnsProps

Pattern Construct Props

Name	Type	Description
eventRuleProps	events.RuleProps	User provided eventRuleProps to override the defaults.
existingTopicObj?	sns.Topic	Existing instance of SNS Topic object, providing both this and topicProps will cause an error.
topicProps?	sns.TopicProps	User provided props to override the default props for the SNS Topic.
existingEventBusInterface?	events.IEventBus	Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
eventBusProps?	events.EventBusProps	Optional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error.
enableEncryptionWithCustomerManagedKey?	boolean	Use a KMS Key, either managed by this CDK app, or imported. If importing an encryption key, it must be specified in the encryptionKey property for this construct.
encryptionKey?	kms.Key	An optional, imported encryption key to encrypt the SNS Topic.
encryptionKeyProps?	kms.KeyProps	An optional, user provided properties to override the default properties for the KMS encryption key.

Pattern Properties

Name	Type	Description
eventBus?	events.IEventBus	Returns the instance of events.IEventBus used by the construct
eventsRule	events.Rule	Returns an instance of events.Rule created by the construct
snsTopic	sns.Topic	Returns an instance of sns.Topic created by the construct
encryptionKey?	kms.Key	Returns an instance of kms Key used for the SNS Topic.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon EventBridge Rule

• Grant least privilege permissions to EventBridge Rule to publish to the SNS Topic.

Amazon SNS Topic

• Configure least privilege access permissions for SNS Topic.
• Enable server-side encryption forSNS Topic using Customer managed KMS Key.
• Enforce encryption of data in transit.

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK Constructs for deploying AWS Events Rule that invokes AWS SNS

Index

• func EventbridgeToSns_IsConstruct(x interface{}) *bool
• func NewEventbridgeToSns_Override(e EventbridgeToSns, scope constructs.Construct, id *string, ...)
• type EventbridgeToSns
  • func NewEventbridgeToSns(scope constructs.Construct, id *string, props *EventbridgeToSnsProps) EventbridgeToSns
• type EventbridgeToSnsProps

Functions

func EventbridgeToSns_IsConstruct

func EventbridgeToSns_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewEventbridgeToSns_Override

func NewEventbridgeToSns_Override(e EventbridgeToSns, scope constructs.Construct, id *string, props *EventbridgeToSnsProps)

Types

type EventbridgeToSns

type EventbridgeToSns interface {
	constructs.Construct
	EncryptionKey() awskms.Key
	EventBus() awsevents.IEventBus
	EventsRule() awsevents.Rule
	Node() constructs.Node
	SnsTopic() awssns.Topic
	ToString() *string
}

func NewEventbridgeToSns

func NewEventbridgeToSns(scope constructs.Construct, id *string, props *EventbridgeToSnsProps) EventbridgeToSns

type EventbridgeToSnsProps

type EventbridgeToSnsProps struct {
	// User provided eventRuleProps to override the defaults.
	EventRuleProps *awsevents.RuleProps `json:"eventRuleProps"`
	// Use a KMS Key, either managed by this CDK app, or imported.
	//
	// If importing an encryption key, it must be specified in
	// the encryptionKey property for this construct.
	EnableEncryptionWithCustomerManagedKey *bool `json:"enableEncryptionWithCustomerManagedKey"`
	// An optional, imported encryption key to encrypt the SQS queue, and SNS Topic.
	EncryptionKey awskms.Key `json:"encryptionKey"`
	// Optional user-provided props to override the default props for the encryption key.
	EncryptionKeyProps *awskms.KeyProps `json:"encryptionKeyProps"`
	// A new custom EventBus is created with provided props.
	EventBusProps *awsevents.EventBusProps `json:"eventBusProps"`
	// Existing instance of a custom EventBus.
	ExistingEventBusInterface awsevents.IEventBus `json:"existingEventBusInterface"`
	// Existing instance of SNS Topic object, providing both this and topicProps will cause an error..
	ExistingTopicObj awssns.Topic `json:"existingTopicObj"`
	// User provided props to override the default props for the SNS Topic.
	TopicProps *awssns.TopicProps `json:"topicProps"`
}