Package: aws-solutions-constructs.aws-events-rule-sns
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/LanguagePackagePythonaws_solutions_constructs.aws_events_rule_snsTypescript@aws-solutions-constructs/aws-events-rule-snsJavasoftware.amazon.awsconstructs.services.eventsrulesnsOverviewThis AWS Solutions Construct implements an AWS Events rule and an AWS SNS Topic.Here is a minimal deployable pattern definition:Typescript//aws-events-rule-snshasbeendeprecatedforCDKV2infavorofaws-eventbridge-sns.//ThissampleusestheCDKV1syntaximport*ascdkfrom'@aws-cdk/core';import*aseventsfrom'@aws-cdk/aws-events';import*asiamfrom'@aws-cdk/aws-iam';import{EventsRuleToSnsProps,EventsRuleToSns}from"@aws-solutions-constructs/aws-events-rule-sns";constconstructProps:EventsRuleToSnsProps={eventRuleProps:{schedule:events.Schedule.rate(cdk.Duration.minutes(5)),}};constconstructStack=newEventsRuleToSns(this,'test',constructProps);//GrantyourselfpermissionstousetheCustomerManagedKMSKeyconstpolicyStatement=newiam.PolicyStatement({actions:["kms:Encrypt","kms:Decrypt"],effect:iam.Effect.ALLOW,principals:[newiam.AccountRootPrincipal()],resources:["*"]});constructStack.encryptionKey?.addToResourcePolicy(policyStatement);Python# aws-events-rule-sns has been deprecated for CDK V2 in favor of aws-eventbridge-sns.# This sample uses the CDK V1 syntaxfromaws_solutions_constructs.aws_events_rule_snsimportEventsRuleToSns,EventsRuleToSnsPropsfromaws_cdkimport(aws_eventsasevents,aws_iamasiam,core)construct_stack=EventsRuleToSns(self,'test',event_rule_props=events.RuleProps(schedule=events.Schedule.rate(core.Duration.minutes(5))))# Grant yourself permissions to use the Customer Managed KMS Keypolicy_statement=iam.PolicyStatement(actions=["kms:Encrypt","kms:Decrypt"],effect=iam.Effect.ALLOW,principals=[iam.AccountRootPrincipal()],resources=["*"])construct_stack.encryption_key.add_to_resource_policy(policy_statement)Java// aws-events-rule-sns has been deprecated for CDK V2 in favor of aws-eventbridge-sns.// This sample uses the CDK V1 syntaximportsoftware.constructs.Construct;importjava.util.List;importsoftware.amazon.awscdk.core.*;importsoftware.amazon.awscdk.services.events.*;importsoftware.amazon.awscdk.services.iam.*;importsoftware.amazon.awsconstructs.services.eventsrulesns.*;finalEventsRuleToSnsconstructStack=newEventsRuleToSns(this,"test",newEventsRuleToSnsProps.Builder().eventRuleProps(newRuleProps.Builder().schedule(Schedule.rate(Duration.minutes(5))).build()).build());// Grant yourself permissions to use the Customer Managed KMS KeyfinalPolicyStatementpolicyStatement=PolicyStatement.Builder.create().actions(List.of("kms:Encrypt","kms:Decrypt")).effect(Effect.ALLOW).principals(List.of(newAccountRootPrincipal())).resources(List.of("*")).build();constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);Pattern Construct PropsNameTypeDescriptioneventRulePropsevents.RulePropsUser provided eventRuleProps to override the defaults.existingTopicObj?sns.TopicExisting instance of SNS Topic object, providing both this andtopicPropswill cause an error.topicProps?sns.TopicPropsUser provided props to override the default props for the SNS Topic.existingEventBusInterface?events.IEventBusOptional user-provided custom EventBus for construct to use. Providing both this andeventBusPropsresults an error.eventBusProps?events.EventBusPropsOptional 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 norexistingEventBusInterfaceis provided the construct will use thedefaultEventBus. Providing both this andexistingEventBusInterfaceresults an error.enableEncryptionWithCustomerManagedKey?booleanUse 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.KeyAn optional, imported encryption key to encrypt the SNS Topic.encryptionKeyProps?kms.KeyPropsAn optional, user provided properties to override the default properties for the KMS encryption key.Pattern PropertiesNameTypeDescriptioneventBus?events.IEventBusReturns the instance of events.IEventBus used by the constructeventsRuleevents.RuleReturns an instance of events.Rule created by the constructsnsTopicsns.TopicReturns an instance of sns.Topic created by the constructencryptionKey?kms.KeyReturns an instance of kms Key used for the SNS Topic.Default settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon EventBridge RuleGrant least privilege permissions to EventBridge Rule to publish to the SNS Topic.Amazon SNS TopicConfigure 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 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.