RedriveAllowPolicy

class aws_cdk.aws_sqs.RedriveAllowPolicy(*, redrive_permission=None, source_queues=None)

Bases: object

Permission settings for the dead letter source queue.

Parameters:

redrive_permission (Optional[RedrivePermission]) – Permission settings for source queues that can designate this queue as their dead-letter queue. Default: - RedrivePermission.BY_QUEUE if sourceQueues is specified,``RedrivePermission.ALLOW_ALL`` otherwise.
source_queues (Optional[Sequence[IQueue]]) – Source queues that can designate this queue as their dead-letter queue. When redrivePermission is set to RedrivePermission.BY_QUEUE, this parameter is required. You can specify up to 10 source queues. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission to RedrivePermission.ALLOW_ALL. When redrivePermission is either RedrivePermission.ALLOW_ALL or RedrivePermission.DENY_ALL, this parameter cannot be set. Default: - Required when redrivePermission is RedrivePermission.BY_QUEUE, cannot be defined otherwise.

ExampleMetadata:

infused

Example:

# source_queue: sqs.IQueue


# Only the sourceQueue can specify this queue as the dead-letter queue.
queue1 = sqs.Queue(self, "Queue2",
    redrive_allow_policy=sqs.RedriveAllowPolicy(
        source_queues=[source_queue]
    )
)

# No source queues can specify this queue as the dead-letter queue.
queue2 = sqs.Queue(self, "Queue",
    redrive_allow_policy=sqs.RedriveAllowPolicy(
        redrive_permission=sqs.RedrivePermission.DENY_ALL
    )
)

Attributes

redrive_permission

Permission settings for source queues that can designate this queue as their dead-letter queue.

Default:

RedrivePermission.BY_QUEUE if sourceQueues is specified,``RedrivePermission.ALLOW_ALL`` otherwise.

source_queues

Source queues that can designate this queue as their dead-letter queue.

When redrivePermission is set to RedrivePermission.BY_QUEUE, this parameter is required.

You can specify up to 10 source queues. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission to RedrivePermission.ALLOW_ALL.

When redrivePermission is either RedrivePermission.ALLOW_ALL or RedrivePermission.DENY_ALL, this parameter cannot be set.

Default:

Required when redrivePermission is RedrivePermission.BY_QUEUE, cannot be defined otherwise.