software.amazon.awscdk.services.sqs

Class Queue

java.lang.Object

software.amazon.jsii.JsiiObject

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:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IResource, IQueue, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.19.0 (build 7c562bc)",
           date="2019-10-15T12:31:30.842Z")
 @Stability(value=Stable)
public class Queue
extends QueueBase

A new Amazon SQS queue.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Queue(software.amazon.awscdk.core.Construct scope, String id)
	Queue(software.amazon.awscdk.core.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.amazon.awscdk.core.Construct scope, String id, String queueArn)
static IQueue	fromQueueAttributes(software.amazon.awscdk.core.Construct scope, String id, QueueAttributes attrs) Import an existing queue.
protected Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
software.amazon.awscdk.services.kms.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.core.Resource

generatePhysicalName, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

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

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

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

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

getStack

Methods inherited from interface software.amazon.awscdk.core.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(software.amazon.awscdk.core.Construct scope,
                                      String id,
                                      QueueProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Queue

@Stability(value=Stable)
public Queue(software.amazon.awscdk.core.Construct scope,
                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromQueueArn

@Stability(value=Stable)
public static IQueue fromQueueArn(software.amazon.awscdk.core.Construct scope,
                                                           String id,
                                                           String queueArn)

Parameters:

scope - This parameter is required.

id - This parameter is required.

queueArn - This parameter is required.

fromQueueAttributes

@Stability(value=Stable)
public static IQueue fromQueueAttributes(software.amazon.awscdk.core.Construct scope,
                                                                  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

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

Controls automatic creation of policy objects. Set by subclasses.

Overrides:

getAutoCreatePolicy in class QueueBase

getFifo

@Stability(value=Stable)
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

Overrides:

getFifo in class QueueBase

getQueueArn

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

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

Overrides:

getQueueArn in class QueueBase

getQueueName

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

The name of this queue.

Specified by:

getQueueName in interface IQueue

Overrides:

getQueueName in class QueueBase

getQueueUrl

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

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

Overrides:

getQueueUrl in class QueueBase

getEncryptionMasterKey

@Stability(value=Stable)
public software.amazon.awscdk.services.kms.IKey getEncryptionMasterKey()

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

Specified by:

getEncryptionMasterKey in interface IQueue

Overrides:

getEncryptionMasterKey in class QueueBase