Class RedriveAllowPolicy

Permission settings for the dead letter source queue.

Inheritance

object

RedriveAllowPolicy

Implements

IRedriveAllowPolicy

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SQS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class RedriveAllowPolicy : IRedriveAllowPolicy

Syntax (vb)

Public Class RedriveAllowPolicy Implements IRedriveAllowPolicy

Remarks

ExampleMetadata: infused

Examples

IQueue sourceQueue;


            // Only the sourceQueue can specify this queue as the dead-letter queue.
            var queue1 = new Queue(this, "Queue2", new QueueProps {
                RedriveAllowPolicy = new RedriveAllowPolicy {
                    SourceQueues = new [] { sourceQueue }
                }
            });

            // No source queues can specify this queue as the dead-letter queue.
            var queue2 = new Queue(this, "Queue", new QueueProps {
                RedriveAllowPolicy = new RedriveAllowPolicy {
                    RedrivePermission = RedrivePermission.DENY_ALL
                }
            });

Synopsis

Constructors

RedriveAllowPolicy()

Permission settings for the dead letter source queue.

Properties

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

Constructors

RedriveAllowPolicy()

Permission settings for the dead letter source queue.

public RedriveAllowPolicy()

Remarks

ExampleMetadata: infused

Examples

IQueue sourceQueue;


            // Only the sourceQueue can specify this queue as the dead-letter queue.
            var queue1 = new Queue(this, "Queue2", new QueueProps {
                RedriveAllowPolicy = new RedriveAllowPolicy {
                    SourceQueues = new [] { sourceQueue }
                }
            });

            // No source queues can specify this queue as the dead-letter queue.
            var queue2 = new Queue(this, "Queue", new QueueProps {
                RedriveAllowPolicy = new RedriveAllowPolicy {
                    RedrivePermission = RedrivePermission.DENY_ALL
                }
            });

Properties

RedrivePermission

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

public RedrivePermission? RedrivePermission { get; set; }

Property Value

RedrivePermission?

Remarks

Default: - RedrivePermission.BY_QUEUE if sourceQueues is specified,RedrivePermission.ALLOW_ALL otherwise.

SourceQueues

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

public IQueue[]? SourceQueues { get; set; }

Property Value

IQueue[]

Remarks

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.

Implements

IRedriveAllowPolicy