software.amazon.awscdk.services.sqs

Class Queue

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sqs.QueueBase

software.amazon.awscdk.services.sqs.Queue

All Implemented Interfaces:

software.amazon.awscdk.IConstruct, software.amazon.awscdk.IDependable, software.amazon.awscdk.IResource, software.amazon.awscdk.services.autoscaling.api.ILifecycleHookTarget, software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination, IQueue, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.10.5 (build 46bc9b0)",
           date="2019-05-24T10:15:31.725Z")
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.Construct scope, String id)
	Queue(software.amazon.awscdk.Construct scope, String id, QueueProps props)
protected	Queue(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
static IQueue	fromQueueArn(software.amazon.awscdk.Construct scope, String id, String queueArn)
static IQueue	fromQueueAttributes(software.amazon.awscdk.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.
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, asBucketNotificationDestination, asLifecycleHookTarget, 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.Construct

getDependencyRoots, getNode, isConstruct, prepare, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IDependable

getDependencyRoots

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Queue

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

Queue

public Queue(software.amazon.awscdk.Construct scope,
             String id,
             @Nullable
             QueueProps props)

Queue

public Queue(software.amazon.awscdk.Construct scope,
             String id)

Method Detail

fromQueueArn

public static IQueue fromQueueArn(software.amazon.awscdk.Construct scope,
                                  String id,
                                  String queueArn)

fromQueueAttributes

public static IQueue fromQueueAttributes(software.amazon.awscdk.Construct scope,
                                         String id,
                                         QueueAttributes attrs)

Import an existing queue.

getAutoCreatePolicy

protected Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects. Set by subclasses.

Overrides:

getAutoCreatePolicy in class QueueBase

getQueueArn

public String getQueueArn()

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

Overrides:

getQueueArn in class QueueBase

getQueueName

public String getQueueName()

The name of this queue.

Specified by:

getQueueName in interface IQueue

Overrides:

getQueueName in class QueueBase

getQueueUrl

public String getQueueUrl()

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

Overrides:

getQueueUrl in class QueueBase

getEncryptionMasterKey

@Nullable
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