EventBusProps

class aws_cdk.aws_events_targets.EventBusProps(*, dead_letter_queue=None, role=None)

Bases: object

Configuration properties of an Event Bus event.

Cannot extend TargetBaseProps. Retry policy is not supported for Event bus targets.

Parameters
  • dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue

  • role (Optional[IRole]) – Role to be used to publish the event. Default: a new role is created.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events_targets as events_targets
import aws_cdk.aws_iam as iam
import aws_cdk.aws_sqs as sqs

# queue: sqs.Queue
# role: iam.Role

event_bus_props = events_targets.EventBusProps(
    dead_letter_queue=queue,
    role=role
)

Attributes

dead_letter_queue

//docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations>`_.

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default
  • no dead-letter queue

Type

The SQS queue to be used as deadLetterQueue. Check out the `considerations for using a dead-letter queue <https

Return type

Optional[IQueue]

role

Role to be used to publish the event.

Default

a new role is created.

Return type

Optional[IRole]