software.amazon.awscdk.services.sqs

Class Queue

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.sqs.QueueBase

software.amazon.awscdk.services.sqs.Queue

All Implemented Interfaces:

IConstruct, IDependable, IResource, IQueue

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.981Z")
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 interface software.amazon.awscdk.services.sqs.IQueue

IQueue.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IQueue	fromQueueArn(software.constructs.Construct scope, java.lang.String id, java.lang.String queueArn) Import an existing SQS queue provided an ARN.
static IQueue	fromQueueAttributes(software.constructs.Construct scope, java.lang.String id, QueueAttributes attrs) Import an existing queue.
protected java.lang.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.
java.lang.Boolean	getFifo() Whether this queue is an Amazon SQS FIFO queue.
java.lang.String	getQueueArn() The ARN of this queue.
java.lang.String	getQueueName() The name of this queue.
java.lang.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, validate

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Queue

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

Queue

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

Queue

public Queue(software.constructs.Construct scope,
             java.lang.String id,
             QueueProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Queue

public Queue(software.constructs.Construct scope,
             java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromQueueArn

public static IQueue fromQueueArn(software.constructs.Construct scope,
                                  java.lang.String id,
                                  java.lang.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

public static IQueue fromQueueAttributes(software.constructs.Construct scope,
                                         java.lang.String id,
                                         QueueAttributes attrs)

Import an existing queue.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getAutoCreatePolicy

protected java.lang.Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects.

Set by subclasses.

Specified by:

getAutoCreatePolicy in class QueueBase

getFifo

public java.lang.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

public java.lang.String getQueueArn()

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

Specified by:

getQueueArn in class QueueBase

getQueueName

public java.lang.String getQueueName()

The name of this queue.

Specified by:

getQueueName in interface IQueue

Specified by:

getQueueName in class QueueBase

getQueueUrl

public java.lang.String getQueueUrl()

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

Specified by:

getQueueUrl in class QueueBase

getDeadLetterQueue

public DeadLetterQueue getDeadLetterQueue()

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

getEncryptionMasterKey

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