@aws-solutions-constructs/aws-eventbridge-sqs 2.75.0 → 2.77.0

package/.jsii

@@ -8,8 +8,8 @@
     "url": "https://aws.amazon.com"
   },
   "dependencies": {
-    "@aws-solutions-constructs/core": "2.75.0",
-    "aws-cdk-lib": "^2.163.1",
+    "@aws-solutions-constructs/core": "2.77.0",
+    "aws-cdk-lib": "^2.177.0",
     "constructs": "^10.0.0"
   },
   "dependencyClosure": {
@@ -1045,6 +1045,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_connectcampaignsv2": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.ConnectCampaignsV2"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.connectcampaignsv2"
+            },
+            "python": {
+              "module": "aws_cdk.aws_connectcampaignsv2"
+            }
+          }
+        },
         "aws-cdk-lib.aws_controltower": {
           "targets": {
             "dotnet": {
@@ -1864,29 +1877,29 @@
             }
           }
         },
-        "aws-cdk-lib.aws_iot": {
+        "aws-cdk-lib.aws_invoicing": {
           "targets": {
             "dotnet": {
-              "namespace": "Amazon.CDK.AWS.IoT"
+              "package": "Amazon.CDK.AWS.Invoicing"
             },
             "java": {
-              "package": "software.amazon.awscdk.services.iot"
+              "package": "software.amazon.awscdk.services.invoicing"
             },
             "python": {
-              "module": "aws_cdk.aws_iot"
+              "module": "aws_cdk.aws_invoicing"
             }
           }
         },
-        "aws-cdk-lib.aws_iot1click": {
+        "aws-cdk-lib.aws_iot": {
           "targets": {
             "dotnet": {
-              "namespace": "Amazon.CDK.AWS.IoT1Click"
+              "namespace": "Amazon.CDK.AWS.IoT"
             },
             "java": {
-              "package": "software.amazon.awscdk.services.iot1click"
+              "package": "software.amazon.awscdk.services.iot"
             },
             "python": {
-              "module": "aws_cdk.aws_iot1click"
+              "module": "aws_cdk.aws_iot"
             }
           }
         },
@@ -2579,6 +2592,32 @@
             }
           }
         },
+        "aws-cdk-lib.aws_notifications": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.Notifications"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.notifications"
+            },
+            "python": {
+              "module": "aws_cdk.aws_notifications"
+            }
+          }
+        },
+        "aws-cdk-lib.aws_notificationscontacts": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.NotificationsContacts"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.notificationscontacts"
+            },
+            "python": {
+              "module": "aws_cdk.aws_notificationscontacts"
+            }
+          }
+        },
         "aws-cdk-lib.aws_oam": {
           "targets": {
             "dotnet": {
@@ -2735,6 +2774,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_pcs": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.PCS"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.pcs"
+            },
+            "python": {
+              "module": "aws_cdk.aws_pcs"
+            }
+          }
+        },
         "aws-cdk-lib.aws_personalize": {
           "targets": {
             "dotnet": {
@@ -2852,6 +2904,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_rbin": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.Rbin"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.rbin"
+            },
+            "python": {
+              "module": "aws_cdk.aws_rbin"
+            }
+          }
+        },
         "aws-cdk-lib.aws_rds": {
           "targets": {
             "dotnet": {
@@ -3177,6 +3242,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_s3tables": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.S3Tables"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.s3tables"
+            },
+            "python": {
+              "module": "aws_cdk.aws_s3tables"
+            }
+          }
+        },
         "aws-cdk-lib.aws_sagemaker": {
           "targets": {
             "dotnet": {
@@ -3883,7 +3961,7 @@
   },
   "description": "CDK Constructs for deploying AWS Eventbridge that invokes AWS SQS",
   "homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
-  "jsiiVersion": "5.4.46 (build 1a0b9d7)",
+  "jsiiVersion": "5.7.4 (build fc2a28e)",
   "keywords": [
     "aws",
     "cdk",
@@ -3902,7 +3980,7 @@
   },
   "name": "@aws-solutions-constructs/aws-eventbridge-sqs",
   "readme": {
-    "markdown": "# aws-eventbridge-sqs module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language**     | **Package**        |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_eventbridge_sqs`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-eventbridge-sqs`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.eventbridgesqs`|\n\n## Overview\nThis AWS Solutions Construct implements an Amazon EventBridge rule and an AWS SQS Queue.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps, Duration } from 'aws-cdk-lib';\nimport * as events from 'aws-cdk-lib/aws-events';\nimport * as iam from 'aws-cdk-lib/aws-iam';\nimport { EventbridgeToSqsProps, EventbridgeToSqs } from \"@aws-solutions-constructs/aws-eventbridge-sqs\";\n\nconst constructProps: EventbridgeToSqsProps = {\n  eventRuleProps: {\n    schedule: events.Schedule.rate(Duration.minutes(5))\n  }\n};\n\nconst constructStack = new EventbridgeToSqs(this, 'test-construct', constructProps);\n\n// Grant yourself permissions to use the Customer Managed KMS Key\nconst policyStatement = new iam.PolicyStatement({\n  actions: [\"kms:Encrypt\", \"kms:Decrypt\"],\n  effect: iam.Effect.ALLOW,\n  principals: [new iam.AccountRootPrincipal()],\n  resources: [\"*\"]\n});\n\nconstructStack.encryptionKey?.addToResourcePolicy(policyStatement);\n```\n\nPython\n``` Python\nfrom aws_solutions_constructs.aws_eventbridge_sqs import EventbridgeToSqsProps, EventbridgeToSqs\nfrom aws_cdk import (\n    aws_events as events,\n    aws_iam as iam,\n    Duration,\n    Stack\n)\nfrom constructs import Construct\n\nconstruct_stack = EventbridgeToSqs(self, 'test-construct',\n                                    event_rule_props=events.RuleProps(\n                                        schedule=events.Schedule.rate(\n                                            Duration.minutes(5))\n                                    ))\n\n# Grant yourself permissions to use the Customer Managed KMS Key\npolicy_statement = iam.PolicyStatement(\n    actions=[\"kms:Encrypt\", \"kms:Decrypt\"],\n    effect=iam.Effect.ALLOW,\n    principals=[iam.AccountRootPrincipal()],\n    resources=[\"*\"]\n)\n\nconstruct_stack.encryption_key.add_to_resource_policy(policy_statement)\n```\n\nJava\n``` java\nimport software.constructs.Construct;\nimport java.util.List;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.Duration;\nimport software.amazon.awscdk.services.events.*;\nimport software.amazon.awscdk.services.iam.*;\nimport software.amazon.awsconstructs.services.eventbridgesqs.*;\n\nfinal EventbridgeToSqs constructStack = new EventbridgeToSqs(this, \"test-construct\",\n        new EventbridgeToSqsProps.Builder()\n                .eventRuleProps(new RuleProps.Builder()\n                        .schedule(Schedule.rate(Duration.minutes(5)))\n                        .build())\n                .build());\n\n// Grant yourself permissions to use the Customer Managed KMS Key\nfinal PolicyStatement policyStatement = PolicyStatement.Builder.create()\n        .actions(List.of(\"kms:Encrypt\", \"kms:Decrypt\"))\n        .effect(Effect.ALLOW)\n        .principals(List.of(new AccountRootPrincipal()))\n        .resources(List.of(\"*\"))\n        .build();\n\nconstructStack.getEncryptionKey().addToResourcePolicy(policyStatement);\n```\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|\n|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html)|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.|\n|eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html)|User provided eventRuleProps to override the defaults. |\n|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and `queueProps` will cause an error.|\n|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|User provided props to override the default props for the SQS Queue. |\n|enableQueuePurging?|`boolean`|Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to `false`.|\n|deployDeadLetterQueue?|`boolean`|Whether to create a secondary queue to be used as a dead letter queue. Defaults to `true`.|\n|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter queue. Only used if the `deployDeadLetterQueue` property is set to true.|\n|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to `15`.|\n|enableEncryptionWithCustomerManagedKey?|`boolean`|If 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.|\n|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|\n|encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|\n|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html)|Returns an instance of events.Rule created by the construct|\n|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of sqs.Queue created by the construct|\n|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|Returns an instance of kms Key used for the SQS queue.|\n|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead-letter SQS queue created by the pattern.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon EventBridge Rule\n* Grant least privilege permissions to EventBridge rule to publish to the SQS Queue.\n\n### Amazon SQS Queue\n* Deploy SQS dead-letter queue for the source SQS Queue.\n* Enable server-side encryption for source SQS Queue using Customer managed KMS Key.\n* Enforce encryption of data in transit.\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
+    "markdown": "# aws-eventbridge-sqs module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language**     | **Package**        |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_eventbridge_sqs`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-eventbridge-sqs`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.eventbridgesqs`|\n\n## Overview\nThis AWS Solutions Construct implements an Amazon EventBridge rule and an AWS SQS Queue.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps, Duration } from 'aws-cdk-lib';\nimport * as events from 'aws-cdk-lib/aws-events';\nimport * as iam from 'aws-cdk-lib/aws-iam';\nimport { EventbridgeToSqsProps, EventbridgeToSqs } from \"@aws-solutions-constructs/aws-eventbridge-sqs\";\n\nconst constructProps: EventbridgeToSqsProps = {\n  eventRuleProps: {\n    schedule: events.Schedule.rate(Duration.minutes(5))\n  }\n};\n\nconst constructStack = new EventbridgeToSqs(this, 'test-construct', constructProps);\n\n// Grant yourself permissions to use the Customer Managed KMS Key\nconst policyStatement = new iam.PolicyStatement({\n  actions: [\"kms:Encrypt\", \"kms:Decrypt\"],\n  effect: iam.Effect.ALLOW,\n  principals: [new iam.AccountRootPrincipal()],\n  resources: [\"*\"]\n});\n\nconstructStack.encryptionKey?.addToResourcePolicy(policyStatement);\n```\n\nPython\n``` Python\nfrom aws_solutions_constructs.aws_eventbridge_sqs import EventbridgeToSqsProps, EventbridgeToSqs\nfrom aws_cdk import (\n    aws_events as events,\n    aws_iam as iam,\n    Duration,\n    Stack\n)\nfrom constructs import Construct\n\nconstruct_stack = EventbridgeToSqs(self, 'test-construct',\n                                    event_rule_props=events.RuleProps(\n                                        schedule=events.Schedule.rate(\n                                            Duration.minutes(5))\n                                    ))\n\n# Grant yourself permissions to use the Customer Managed KMS Key\npolicy_statement = iam.PolicyStatement(\n    actions=[\"kms:Encrypt\", \"kms:Decrypt\"],\n    effect=iam.Effect.ALLOW,\n    principals=[iam.AccountRootPrincipal()],\n    resources=[\"*\"]\n)\n\nconstruct_stack.encryption_key.add_to_resource_policy(policy_statement)\n```\n\nJava\n``` java\nimport software.constructs.Construct;\nimport java.util.List;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.Duration;\nimport software.amazon.awscdk.services.events.*;\nimport software.amazon.awscdk.services.iam.*;\nimport software.amazon.awsconstructs.services.eventbridgesqs.*;\n\nfinal EventbridgeToSqs constructStack = new EventbridgeToSqs(this, \"test-construct\",\n        new EventbridgeToSqsProps.Builder()\n                .eventRuleProps(new RuleProps.Builder()\n                        .schedule(Schedule.rate(Duration.minutes(5)))\n                        .build())\n                .build());\n\n// Grant yourself permissions to use the Customer Managed KMS Key\nfinal PolicyStatement policyStatement = PolicyStatement.Builder.create()\n        .actions(List.of(\"kms:Encrypt\", \"kms:Decrypt\"))\n        .effect(Effect.ALLOW)\n        .principals(List.of(new AccountRootPrincipal()))\n        .resources(List.of(\"*\"))\n        .build();\n\nconstructStack.getEncryptionKey().addToResourcePolicy(policyStatement);\n```\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|\n|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html)|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.|\n|eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html)|User provided eventRuleProps to override the defaults. |\n|targetProps?|[`eventtargets.SqsQueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets.SqsQueueProps.html)|Optional user provided properties to define the SQS target on the Event Rule. If you specify a deadLetterQueue for the rule here, you are responsible for adding a resource policy to the queue allowing events.amazonaws.com permission to SendMessage, GetQueueUrl and GetQueueAttributes. You cannot send a DLQ in this property and set deployEventRuleDlq to true. Default is undefined and all system defaults are used.|\n|eventRuleDlqKeyProps|[kms.KeyProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.KeyProps.html)|Optional properties to define the key created to protect the ruleDlq. Only valid if deployRuleDlq is set to true. Defaults to CloudFormation defaults.|\n| deployEventRuleDlq?|boolean|Whether to deploy a DLQ for the Event Rule. If set to `true`, this DLQ will receive any messages that can't be delivered to the target SQS queue. Defaults to `false`.|\n|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and `queueProps` will cause an error.|\n|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|User provided props to override the default props for the SQS Queue. |\n|enableQueuePurging?|`boolean`|Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to `false`.|\n|deployDeadLetterQueue?|`boolean`|Whether to create a secondary queue to be used as a dead letter queue. Defaults to `true`.|\n|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter queue. Only used if the `deployDeadLetterQueue` property is set to true.|\n|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to `15`.|\n|enableEncryptionWithCustomerManagedKey?|`boolean`|If 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.|\n|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional, imported encryption key to encrypt the SQS Queue with.|\n|encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|\n|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html)|Returns an instance of events.Rule created by the construct|\n|eventRuleDlq?|`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|If the client sets deployEventRuleDlq to 'true', then this value will contain the DLQ set up for the rule.|\n|eventRuleDlqKey|[kms.IKey](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html)|The key created to encrypt the eventRuleDlq.|\n|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of sqs.Queue created by the construct|\n|encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|Returns an instance of kms Key used for the SQS queue.|\n|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead-letter SQS queue created by the pattern.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon EventBridge Rule\n* Grant least privilege permissions to EventBridge rule to publish to the SQS Queue.\n\n### Amazon SQS Queue\n* Deploy SQS dead-letter queue for the source SQS Queue.\n* Enable server-side encryption for source SQS Queue using Customer managed KMS Key.\n* Enforce encryption of data in transit.\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
   },
   "repository": {
     "directory": "source/patterns/@aws-solutions-constructs/aws-eventbridge-sqs",
@@ -3947,7 +4025,7 @@
         },
         "locationInModule": {
           "filename": "lib/index.ts",
-          "line": 117
+          "line": 144
         },
         "parameters": [
           {
@@ -3982,7 +4060,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/index.ts",
-        "line": 102
+        "line": 127
       },
       "name": "EventbridgeToSqs",
       "properties": [
@@ -3990,7 +4068,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 106
+            "line": 131
           },
           "name": "eventsRule",
           "type": {
@@ -4001,7 +4079,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 103
+            "line": 128
           },
           "name": "sqsQueue",
           "type": {
@@ -4012,7 +4090,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 104
+            "line": 129
           },
           "name": "deadLetterQueue",
           "optional": true,
@@ -4024,7 +4102,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 107
+            "line": 132
           },
           "name": "encryptionKey",
           "optional": true,
@@ -4036,13 +4114,37 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 105
+            "line": 130
           },
           "name": "eventBus",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_events.IEventBus"
           }
+        },
+        {
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/index.ts",
+            "line": 133
+          },
+          "name": "eventRuleDlq",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sqs.Queue"
+          }
+        },
+        {
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/index.ts",
+            "line": 134
+          },
+          "name": "eventRuleDlqKey",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_kms.IKey"
+          }
         }
       ],
       "symbolId": "lib/index:EventbridgeToSqs"
@@ -4059,7 +4161,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/index.ts",
-        "line": 26
+        "line": 27
       },
       "name": "EventbridgeToSqsProps",
       "properties": [
@@ -4072,7 +4174,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 44
+            "line": 45
           },
           "name": "eventRuleProps",
           "type": {
@@ -4088,7 +4190,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 68
+            "line": 93
           },
           "name": "deadLetterQueueProps",
           "optional": true,
@@ -4105,7 +4207,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 74
+            "line": 99
           },
           "name": "deployDeadLetterQueue",
           "optional": true,
@@ -4113,6 +4215,24 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- false",
+            "remarks": "If set to `true`, this DLQ will\nreceive any messages that can't be delivered to the target SQS queue.",
+            "summary": "Whether to deploy a DLQ for the Event Rule."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/index.ts",
+            "line": 52
+          },
+          "name": "deployEventRuleDlq",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4123,7 +4243,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 87
+            "line": 112
           },
           "name": "enableEncryptionWithCustomerManagedKey",
           "optional": true,
@@ -4140,7 +4260,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 62
+            "line": 77
           },
           "name": "enableQueuePurging",
           "optional": true,
@@ -4157,7 +4277,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 93
+            "line": 118
           },
           "name": "encryptionKey",
           "optional": true,
@@ -4174,7 +4294,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 99
+            "line": 124
           },
           "name": "encryptionKeyProps",
           "optional": true,
@@ -4191,7 +4311,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 38
+            "line": 39
           },
           "name": "eventBusProps",
           "optional": true,
@@ -4199,6 +4319,23 @@
             "fqn": "aws-cdk-lib.aws_events.EventBusProps"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- default props are used",
+            "summary": "Properties to define the key created to protect the ruleDlq Only valid if deployEventRuleDlq is set to true."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/index.ts",
+            "line": 59
+          },
+          "name": "eventRuleDlqKeyProps",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_kms.KeyProps"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4208,7 +4345,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 32
+            "line": 33
           },
           "name": "existingEventBusInterface",
           "optional": true,
@@ -4225,7 +4362,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 50
+            "line": 65
           },
           "name": "existingQueueObj",
           "optional": true,
@@ -4242,7 +4379,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 80
+            "line": 105
           },
           "name": "maxReceiveCount",
           "optional": true,
@@ -4259,18 +4396,36 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/index.ts",
-            "line": 56
+            "line": 71
           },
           "name": "queueProps",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_sqs.QueueProps"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- undefined (all default values are used)",
+            "remarks": "If you specify a deadLetterQueue for the rule here, you are responsible for adding a resource policy\nto the queue allowing events.amazonaws.com permission to SendMessage, GetQueueUrl and GetQueueAttributes. You\ncannot send a DLQ in this property and set deployRuleDlq to true",
+            "summary": "Optional user provided properties to define the SQS target on the Event Rule."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/index.ts",
+            "line": 87
+          },
+          "name": "targetProps",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_events_targets.SqsQueueProps"
+          }
         }
       ],
       "symbolId": "lib/index:EventbridgeToSqsProps"
     }
   },
-  "version": "2.75.0",
-  "fingerprint": "60kdC5p9QQCYWaeTegCbG6/hDFZhtiwbuOB6ZBYxUIU="
+  "version": "2.77.0",
+  "fingerprint": "eGJaEgwQZyo4ImTIz9Rv19ipdz3chbyMSwlLg7i6UWY="
 }

package/README.md

@@ -115,6 +115,9 @@ constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);
 |existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|
 |eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.EventBusProps.html)|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.|
 |eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.RuleProps.html)|User provided eventRuleProps to override the defaults. |
+|targetProps?|[`eventtargets.SqsQueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets.SqsQueueProps.html)|Optional user provided properties to define the SQS target on the Event Rule. If you specify a deadLetterQueue for the rule here, you are responsible for adding a resource policy to the queue allowing events.amazonaws.com permission to SendMessage, GetQueueUrl and GetQueueAttributes. You cannot send a DLQ in this property and set deployEventRuleDlq to true. Default is undefined and all system defaults are used.|
+|eventRuleDlqKeyProps|[kms.KeyProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.KeyProps.html)|Optional properties to define the key created to protect the ruleDlq. Only valid if deployRuleDlq is set to true. Defaults to CloudFormation defaults.|
+| deployEventRuleDlq?|boolean|Whether to deploy a DLQ for the Event Rule. If set to `true`, this DLQ will receive any messages that can't be delivered to the target SQS queue. Defaults to `false`.|
 |existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and `queueProps` will cause an error.|
 |queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|User provided props to override the default props for the SQS Queue. |
 |enableQueuePurging?|`boolean`|Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to `false`.|
@@ -131,6 +134,8 @@ constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);
 |:-------------|:----------------|-----------------|
 |eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|
 |eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html)|Returns an instance of events.Rule created by the construct|
+|eventRuleDlq?|`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|If the client sets deployEventRuleDlq to 'true', then this value will contain the DLQ set up for the rule.|
+|eventRuleDlqKey|[kms.IKey](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html)|The key created to encrypt the eventRuleDlq.|
 |sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of sqs.Queue created by the construct|
 |encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|Returns an instance of kms Key used for the SQS queue.|
 |deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead-letter SQS queue created by the pattern.|

package/lib/index.d.ts

@@ -12,6 +12,7 @@
  */
 import * as sqs from 'aws-cdk-lib/aws-sqs';
 import * as events from 'aws-cdk-lib/aws-events';
+import * as eventtargets from 'aws-cdk-lib/aws-events-targets';
 import * as kms from 'aws-cdk-lib/aws-kms';
 import { Construct } from 'constructs';
 /**
@@ -36,6 +37,20 @@ export interface EventbridgeToSqsProps {
      * @default - None
      */
     readonly eventRuleProps: events.RuleProps;
+    /**
+     * Whether to deploy a DLQ for the Event Rule. If set to `true`, this DLQ will
+     * receive any messages that can't be delivered to the target SQS queue.
+     *
+     * @default - false
+     */
+    readonly deployEventRuleDlq?: boolean;
+    /**
+     * Properties to define the key created to protect the ruleDlq
+     * Only valid if deployEventRuleDlq is set to true
+     *
+     * @default - default props are used
+     */
+    readonly eventRuleDlqKeyProps?: kms.KeyProps;
     /**
      * Existing instance of SQS queue object, providing both this and queueProps will cause an error.
      *
@@ -54,6 +69,16 @@ export interface EventbridgeToSqsProps {
      * @default - "false", disabled by default.
      */
     readonly enableQueuePurging?: boolean;
+    /**
+     * Optional user provided properties to define the SQS target on the Event Rule
+     *
+     * If you specify a deadLetterQueue for the rule here, you are responsible for adding a resource policy
+     * to the queue allowing events.amazonaws.com permission to SendMessage, GetQueueUrl and GetQueueAttributes. You
+     * cannot send a DLQ in this property and set deployRuleDlq to true
+     *
+     * @default - undefined (all default values are used)
+     */
+    readonly targetProps?: eventtargets.SqsQueueProps;
     /**
      * Optional user provided properties for the dead letter queue
      *
@@ -98,6 +123,8 @@ export declare class EventbridgeToSqs extends Construct {
     readonly eventBus?: events.IEventBus;
     readonly eventsRule: events.Rule;
     readonly encryptionKey?: kms.IKey;
+    readonly eventRuleDlq?: sqs.Queue;
+    readonly eventRuleDlqKey?: kms.IKey;
     /**
      * @summary Constructs a new instance of the EventbridgeToSqs class.
      * @param {cdk.App} scope - represents the scope for all the resources.