Package software.amazon.awscdk.services.sqs

Interface RedriveAllowPolicy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RedriveAllowPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:24.095Z")
@Stability(Stable)
public interface RedriveAllowPolicy
extends software.amazon.jsii.JsiiSerializable

Permission settings for the dead letter source queue.

Example:

 IQueue sourceQueue;
 // Only the sourceQueue can specify this queue as the dead-letter queue.
 Queue queue1 = Queue.Builder.create(this, "Queue2")
         .redriveAllowPolicy(RedriveAllowPolicy.builder()
                 .sourceQueues(List.of(sourceQueue))
                 .build())
         .build();
 // No source queues can specify this queue as the dead-letter queue.
 Queue queue2 = Queue.Builder.create(this, "Queue")
         .redriveAllowPolicy(RedriveAllowPolicy.builder()
                 .redrivePermission(RedrivePermission.DENY_ALL)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RedriveAllowPolicy.Builder	A builder for RedriveAllowPolicy
static final class	RedriveAllowPolicy.Jsii$Proxy	An implementation for RedriveAllowPolicy

Method Summary

Modifier and Type	Method	Description
static RedriveAllowPolicy.Builder	builder()
default RedrivePermission	getRedrivePermission()	Permission settings for source queues that can designate this queue as their dead-letter queue.
default List<IQueue>	getSourceQueues()	Source queues that can designate this queue as their dead-letter queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRedrivePermission

@Stability(Stable)
@Nullable
default RedrivePermission getRedrivePermission()

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.

getSourceQueues

@Stability(Stable)
@Nullable
default List<IQueue> getSourceQueues()

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.

builder

@Stability(Stable)
static RedriveAllowPolicy.Builder builder()

Returns:

a RedriveAllowPolicy.Builder of RedriveAllowPolicy