SqsQueueProps

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

Bases: TargetBaseProps

Customize the SQS Queue Event Target.

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

  • 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

  • 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)

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 as events
import aws_cdk.aws_events_targets as events_targets
import aws_cdk.aws_sqs as sqs
import aws_cdk.core as cdk

# queue: sqs.Queue
# rule_target_input: events.RuleTargetInput

sqs_queue_props = events_targets.SqsQueueProps(
    dead_letter_queue=queue,
    max_event_age=cdk.Duration.minutes(30),
    message=rule_target_input,
    message_group_id="messageGroupId",
    retry_attempts=123
)

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

max_event_age

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)

message

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

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)

retry_attempts

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default:

185