Package software.amazon.awscdk.services.sqs

Enum RedrivePermission

java.lang.Object

java.lang.Enum<RedrivePermission>

software.amazon.awscdk.services.sqs.RedrivePermission

All Implemented Interfaces:

Serializable, Comparable<RedrivePermission>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.505Z")
@Stability(Stable)
public enum RedrivePermission
extends Enum<RedrivePermission>

The permission type that defines which source queues can specify the current queue as the dead-letter 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/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_ALL	Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
BY_QUEUE	Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
DENY_ALL	No source queues can specify this queue as the dead-letter queue.

Method Summary

Modifier and Type	Method	Description
static RedrivePermission	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RedrivePermission[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW_ALL

@Stability(Stable)
public static final RedrivePermission ALLOW_ALL

Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

DENY_ALL

@Stability(Stable)
public static final RedrivePermission DENY_ALL

No source queues can specify this queue as the dead-letter queue.

BY_QUEUE

@Stability(Stable)
public static final RedrivePermission BY_QUEUE

Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

Method Details

values

public static RedrivePermission[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RedrivePermission valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null