aws-cdk-lib 2.162.1__py3-none-any.whl → 2.163.1__py3-none-any.whl

aws_cdk/aws_events/__init__.py

@@ -220,6 +220,23 @@ bus.archive("MyArchive",
 )
 ```
 
+## Dead-Letter Queue for EventBus
+
+It is possible to configure a [Dead Letter Queue for an EventBus](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq). This is useful when you want to capture events that could not be delivered to any of the targets.
+
+To configure a Dead Letter Queue for an EventBus, you can use the `deadLetterQueue` property of the `EventBus` construct.
+
+```python
+import aws_cdk.aws_sqs as sqs
+
+
+dlq = sqs.Queue(self, "DLQ")
+
+bus = events.EventBus(self, "Bus",
+    dead_letter_queue=dlq
+)
+```
+
 ## Granting PutEvents to an existing EventBus
 
 To import an existing EventBus into your CDK application, use `EventBus.fromEventBusArn`, `EventBus.fromEventBusAttributes`
@@ -311,6 +328,7 @@ from ..aws_iam import (
     PolicyStatement as _PolicyStatement_0fe33853,
 )
 from ..aws_kms import IKey as _IKey_5f11635f
+from ..aws_sqs import IQueue as _IQueue_7ed6f679
 
 
 @jsii.data_type(
@@ -8203,6 +8221,7 @@ class EventBusPolicyProps:
     jsii_type="aws-cdk-lib.aws_events.EventBusProps",
     jsii_struct_bases=[],
     name_mapping={
+        "dead_letter_queue": "deadLetterQueue",
         "description": "description",
         "event_bus_name": "eventBusName",
         "event_source_name": "eventSourceName",
@@ -8213,6 +8232,7 @@ class EventBusProps:
     def __init__(
         self,
         *,
+        dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
         description: typing.Optional[builtins.str] = None,
         event_bus_name: typing.Optional[builtins.str] = None,
         event_source_name: typing.Optional[builtins.str] = None,
@@ -8220,6 +8240,7 @@ class EventBusProps:
     ) -> None:
         '''Properties to define an event bus.
 
+        :param dead_letter_queue: Dead-letter queue for the event bus. Default: - no dead-letter queue
         :param description: The event bus description. The description can be up to 512 characters long. Default: - no description
         :param event_bus_name: The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this. Default: - automatically generated name
         :param event_source_name: The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this. Default: - no partner event source
@@ -8249,11 +8270,14 @@ class EventBusProps:
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__298a8c4285f4e039344007a0deb097d820ddec52c59d396d7a8faa1aa9c8b743)
+            check_type(argname="argument dead_letter_queue", value=dead_letter_queue, expected_type=type_hints["dead_letter_queue"])
             check_type(argname="argument description", value=description, expected_type=type_hints["description"])
             check_type(argname="argument event_bus_name", value=event_bus_name, expected_type=type_hints["event_bus_name"])
             check_type(argname="argument event_source_name", value=event_source_name, expected_type=type_hints["event_source_name"])
             check_type(argname="argument kms_key", value=kms_key, expected_type=type_hints["kms_key"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if dead_letter_queue is not None:
+            self._values["dead_letter_queue"] = dead_letter_queue
         if description is not None:
             self._values["description"] = description
         if event_bus_name is not None:
@@ -8263,6 +8287,17 @@ class EventBusProps:
         if kms_key is not None:
             self._values["kms_key"] = kms_key
 
+    @builtins.property
+    def dead_letter_queue(self) -> typing.Optional[_IQueue_7ed6f679]:
+        '''Dead-letter queue for the event bus.
+
+        :default: - no dead-letter queue
+
+        :see: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq
+        '''
+        result = self._values.get("dead_letter_queue")
+        return typing.cast(typing.Optional[_IQueue_7ed6f679], result)
+
     @builtins.property
     def description(self) -> typing.Optional[builtins.str]:
         '''The event bus description.
@@ -11447,6 +11482,7 @@ class EventBus(
         scope: _constructs_77d1e7e8.Construct,
         id: builtins.str,
         *,
+        dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
         description: typing.Optional[builtins.str] = None,
         event_bus_name: typing.Optional[builtins.str] = None,
         event_source_name: typing.Optional[builtins.str] = None,
@@ -11455,6 +11491,7 @@ class EventBus(
         '''
         :param scope: -
         :param id: -
+        :param dead_letter_queue: Dead-letter queue for the event bus. Default: - no dead-letter queue
         :param description: The event bus description. The description can be up to 512 characters long. Default: - no description
         :param event_bus_name: The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this. Default: - automatically generated name
         :param event_source_name: The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this. Default: - no partner event source
@@ -11465,6 +11502,7 @@ class EventBus(
             check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
         props = EventBusProps(
+            dead_letter_queue=dead_letter_queue,
             description=description,
             event_bus_name=event_bus_name,
             event_source_name=event_source_name,
@@ -12671,6 +12709,7 @@ def _typecheckingstub__30683f3da3ccc9235ea663f165631b4ac57c807c1878517c5051bcd78
 
 def _typecheckingstub__298a8c4285f4e039344007a0deb097d820ddec52c59d396d7a8faa1aa9c8b743(
     *,
+    dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
     description: typing.Optional[builtins.str] = None,
     event_bus_name: typing.Optional[builtins.str] = None,
     event_source_name: typing.Optional[builtins.str] = None,
@@ -13068,6 +13107,7 @@ def _typecheckingstub__95a51d19a0503daf5e05f08738b44a6276eaa23c373c99735de37b124
     scope: _constructs_77d1e7e8.Construct,
     id: builtins.str,
     *,
+    dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
     description: typing.Optional[builtins.str] = None,
     event_bus_name: typing.Optional[builtins.str] = None,
     event_source_name: typing.Optional[builtins.str] = None,