Package: aws-solutions-constructs.aws-eventbridge-sqs
aws-eventbridge-sqs module---Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_eventbridge_sqsTypescript@aws-solutions-constructs/aws-eventbridge-sqsJavasoftware.amazon.awsconstructs.services.eventbridgesqsOverviewThis AWS Solutions Construct implements an Amazon EventBridge rule and an AWS SQS Queue.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{EventbridgeToSqsProps,EventbridgeToSqs}from"@aws-solutions-constructs/aws-eventbridge-sqs";constconstructProps:EventbridgeToSqsProps={eventRuleProps:{schedule:events.Schedule.rate(Duration.minutes(5))}};constconstructStack=newEventbridgeToSqs(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_sqsimportEventbridgeToSqsProps,EventbridgeToSqsfromaws_cdkimport(aws_eventsasevents,aws_iamasiam,Duration,Stack)fromconstructsimportConstructconstruct_stack=EventbridgeToSqs(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.eventbridgesqs.*;finalEventbridgeToSqsconstructStack=newEventbridgeToSqs(this,"test-construct",newEventbridgeToSqsProps.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 PropsNameTypeDescriptionexistingEventBusInterface?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.eventRulePropsevents.RulePropsUser provided eventRuleProps to override the defaults.existingQueueObj?sqs.QueueAn optional, existing SQS queue to be used instead of the default queue. Providing both this andqueuePropswill cause an error.queueProps?sqs.QueuePropsUser provided props to override the default props for the SQS Queue.enableQueuePurging?booleanWhether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults tofalse.deployDeadLetterQueue?booleanWhether to create a secondary queue to be used as a dead letter queue. Defaults totrue.deadLetterQueueProps?sqs.QueuePropsOptional user-provided props to override the default props for the dead letter queue. Only used if thedeployDeadLetterQueueproperty is set to true.maxReceiveCount?numberThe number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to15.enableEncryptionWithCustomerManagedKey?booleanIf no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.encryptionKey?kms.KeyAn optional, imported encryption key to encrypt the SQS Queue with.encryptionKeyProps?kms.KeyPropsOptional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.Pattern PropertiesNameTypeDescriptioneventBus?events.IEventBusReturns the instance of events.IEventBus used by the constructeventsRuleevents.RuleReturns an instance of events.Rule created by the constructsqsQueuesqs.QueueReturns an instance of sqs.Queue created by the constructencryptionKey?kms.KeyReturns an instance of kms Key used for the SQS queue.deadLetterQueue?sqs.QueueReturns an instance of the dead-letter SQS queue created by the pattern.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 SQS Queue.Amazon SQS QueueDeploy SQS dead-letter queue for the source SQS Queue.Enable server-side encryption for source SQS Queue using Customer managed KMS Key.Enforce encryption of data in transit.Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.