@aws-solutions-constructs/aws-events-rule-sns NPM

aws-events-rule-sns module

Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-eventbridge-sns.

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

Language	Package
Python	`aws_solutions_constructs.aws_events_rule_sns`
Typescript	`@aws-solutions-constructs/aws-events-rule-sns`
Java	`software.amazon.awsconstructs.services.eventsrulesns`

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 { EventsRuleToSnsProps, EventsRuleToSns } from "@aws-solutions-constructs/aws-events-rule-sns";

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

const constructStack = new EventsRuleToSns(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 EventsRuleToSns(scope: Construct, id: string, props: EventsRuleToSnsProps);

Parameters

scope Construct
id string
props EventsRuleToSnsProps

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.