Package: aws-solutions-constructs.aws-eventbridge-sns
aws-eventbridge-sns module---Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_eventbridge_snsTypescript@aws-solutions-constructs/aws-eventbridge-snsJavasoftware.amazon.awsconstructs.services.eventbridgesnsOverviewThis AWS Solutions Construct implements an AWS Events rule and an AWS SNS Topic.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps,Duration}from'aws-cdk-lib';import*aseventsfrom'aws-cdk-lib/aws-events';import*asiamfrom'aws-cdk-lib/aws-iam';import{EventbridgeToSnsProps,EventbridgeToSns}from"@aws-solutions-constructs/aws-eventbridge-sns";constconstructProps:EventbridgeToSnsProps={eventRuleProps:{schedule:events.Schedule.rate(Duration.minutes(5))}};constconstructStack=newEventbridgeToSns(this,'test-construct',constructProps);//GrantyourselfpermissionstousetheCustomerManagedKMSKeyconstpolicyStatement=newiam.PolicyStatement({actions:["kms:Encrypt","kms:Decrypt"],effect:iam.Effect.ALLOW,principals:[newiam.AccountRootPrincipal()],resources:["*"]});constructStack.encryptionKey?.addToResourcePolicy(policyStatement);Pythonfromaws_solutions_constructs.aws_eventbridge_snsimportEventbridgeToSns,EventbridgeToSnsPropsfromaws_cdkimport(aws_eventsasevents,aws_iamasiam,Duration,Stack)fromconstructsimportConstructconstruct_stack=EventbridgeToSns(self,'test-construct',event_rule_props=events.RuleProps(schedule=events.Schedule.rate(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)Javaimportsoftware.constructs.Construct;importjava.util.List;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.Duration;importsoftware.amazon.awscdk.services.events.*;importsoftware.amazon.awscdk.services.iam.*;importsoftware.amazon.awsconstructs.services.eventbridgesns.*;finalEventbridgeToSnsconstructStack=newEventbridgeToSns(this,"test-construct",newEventbridgeToSnsProps.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?booleanIf no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.encryptionKey?kms.KeyAn optional, imported encryption key to encrypt the SNS Topic with.encryptionKeyProps?kms.KeyPropsOptional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.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 Amazon.com, Inc. or its affiliates. All Rights Reserved.