Package: aws-solutions-constructs.aws-events-rule-sqs
aws-events-rule-sqs 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-sqs.Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_events_rule_sqsTypescript@aws-solutions-constructs/aws-events-rule-sqsJavasoftware.amazon.awsconstructs.services.eventsrulesqsOverviewThis AWS Solutions Construct implements an AWS Events rule and an AWS SQS Queue.Here is a minimal deployable pattern definition:Typescript//aws-events-rule-sqshasbeendeprecatedforCDKV2infavorofaws-eventbridge-sqs.//ThissampleusestheCDKV1syntaximport*ascdkfrom'@aws-cdk/core';import*aseventsfrom'@aws-cdk/aws-events';import*asiamfrom'@aws-cdk/aws-iam';import{EventsRuleToSqsProps,EventsRuleToSqs}from"@aws-solutions-constructs/aws-events-rule-sqs";constconstructProps:EventsRuleToSqsProps={eventRuleProps:{schedule:events.Schedule.rate(cdk.Duration.minutes(5))}};constconstructStack=newEventsRuleToSqs(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-sqs has been deprecated for CDK V2 in favor of aws-eventbridge-sqs.# This sample uses the CDK V1 syntaxfromaws_solutions_constructs.aws_events_rule_sqsimportEventsRuleToSqsfromaws_cdkimport(aws_eventsasevents,aws_iamasiam,core)construct_stack=EventsRuleToSqs(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-sqs has been deprecated for CDK V2 in favor of aws-eventbridge-sqs.// 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.eventsrulesqs.*;finalEventsRuleToSqsconstructStack=newEventsRuleToSqs(this,"test-construct",newEventsRuleToSqsProps.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?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 SQS queue.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 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 CloudWatch Events RuleGrant least privilege permissions to CloudWatch Events 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 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.