SqsQueue

class aws_cdk.aws_events_targets.SqsQueue(queue, *, message=None, message_group_id=None, dead_letter_queue=None, max_event_age=None, retry_attempts=None)

Bases: object

Use an SQS Queue as a target for Amazon EventBridge rules.

Example:

# publish to an SQS queue every time code is committed
# to a CodeCommit repository
repository.on_commit("onCommit", target=targets.SqsQueue(queue))
Parameters
  • queue (IQueue) –

  • message (Optional[RuleTargetInput]) – The message to send to the queue. Must be a valid JSON text passed to the target queue. Default: the entire EventBridge event

  • message_group_id (Optional[str]) – Message Group ID for messages sent to this queue. Required for FIFO queues, leave empty for regular queues. Default: - no message group ID (regular queue)

  • 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

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

Methods

bind(rule, _id=None)

Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.

Parameters
  • rule (IRule) –

  • _id (Optional[str]) –

See

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions

Return type

RuleTargetConfig

Attributes

queue
Return type

IQueue