software.amazon.awscdk.services.sqs

Class Queue

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sqs.QueueBase

software.amazon.awscdk.services.sqs.Queue

All Implemented Interfaces:

IResource, IQueue, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.274Z")
 @Stability(value=Stable)
public class Queue
extends QueueBase

A new Amazon SQS queue.

Example:

 // An sqs queue for unsuccessful invocations of a lambda function
 import software.amazon.awscdk.services.sqs.*;
 Queue deadLetterQueue = new Queue(this, "DeadLetterQueue");
 Function myFn = Function.Builder.create(this, "Fn")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromInline("// your code"))
         // sqs queue for unsuccessful invocations
         .onFailure(new SqsDestination(deadLetterQueue))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Queue.Builder A fluent builder for Queue.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sqs.IQueue

IQueue.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Queue(software.constructs.Construct scope, String id)
	Queue(software.constructs.Construct scope, String id, QueueProps props)
protected	Queue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Queue(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IQueue	fromQueueArn(software.constructs.Construct scope, String id, String queueArn) Import an existing SQS queue provided an ARN.
static IQueue	fromQueueAttributes(software.constructs.Construct scope, String id, QueueAttributes attrs) Import an existing queue.
protected Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
DeadLetterQueue	getDeadLetterQueue() If this queue is configured with a dead-letter queue, this is the dead-letter queue settings.
IKey	getEncryptionMasterKey() If this queue is encrypted, this is the KMS key.
Boolean	getFifo() Whether this queue is an Amazon SQS FIFO queue.
String	getQueueArn() The ARN of this queue.
String	getQueueName() The name of this queue.
String	getQueueUrl() The URL of this queue.

Methods inherited from class software.amazon.awscdk.services.sqs.QueueBase

addToResourcePolicy, grant, grantConsumeMessages, grantPurge, grantSendMessages, metric, metric, metricApproximateAgeOfOldestMessage, metricApproximateAgeOfOldestMessage, metricApproximateNumberOfMessagesDelayed, metricApproximateNumberOfMessagesDelayed, metricApproximateNumberOfMessagesNotVisible, metricApproximateNumberOfMessagesNotVisible, metricApproximateNumberOfMessagesVisible, metricApproximateNumberOfMessagesVisible, metricNumberOfEmptyReceives, metricNumberOfEmptyReceives, metricNumberOfMessagesDeleted, metricNumberOfMessagesDeleted, metricNumberOfMessagesReceived, metricNumberOfMessagesReceived, metricNumberOfMessagesSent, metricNumberOfMessagesSent, metricSentMessageSize, metricSentMessageSize

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Queue

protected Queue(software.amazon.jsii.JsiiObjectRef objRef)

Queue

protected Queue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Queue

@Stability(value=Stable)
public Queue(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id,
                                      @Nullable
                                      QueueProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Queue

@Stability(value=Stable)
public Queue(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromQueueArn

@Stability(value=Stable)
 @NotNull
public static IQueue fromQueueArn(@NotNull
                                                                     software.constructs.Construct scope,
                                                                     @NotNull
                                                                     String id,
                                                                     @NotNull
                                                                     String queueArn)

Import an existing SQS queue provided an ARN.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

queueArn - queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1). This parameter is required.

fromQueueAttributes

@Stability(value=Stable)
 @NotNull
public static IQueue fromQueueAttributes(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            QueueAttributes attrs)

Import an existing queue.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getAutoCreatePolicy

@Stability(value=Stable)
 @NotNull
protected Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects.

Set by subclasses.

Specified by:

getAutoCreatePolicy in class QueueBase

getFifo

@Stability(value=Stable)
 @NotNull
public Boolean getFifo()

Whether this queue is an Amazon SQS FIFO queue.

If false, this is a standard queue.

Specified by:

getFifo in interface IQueue

Specified by:

getFifo in class QueueBase

getQueueArn

@Stability(value=Stable)
 @NotNull
public String getQueueArn()

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

Specified by:

getQueueArn in class QueueBase

getQueueName

@Stability(value=Stable)
 @NotNull
public String getQueueName()

The name of this queue.

Specified by:

getQueueName in interface IQueue

Specified by:

getQueueName in class QueueBase

getQueueUrl

@Stability(value=Stable)
 @NotNull
public String getQueueUrl()

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

Specified by:

getQueueUrl in class QueueBase

getDeadLetterQueue

@Stability(value=Stable)
 @Nullable
public DeadLetterQueue getDeadLetterQueue()

If this queue is configured with a dead-letter queue, this is the dead-letter queue settings.

getEncryptionMasterKey

@Stability(value=Stable)
 @Nullable
public IKey getEncryptionMasterKey()

If this queue is encrypted, this is the KMS key.

Specified by:

getEncryptionMasterKey in interface IQueue

Specified by:

getEncryptionMasterKey in class QueueBase