software.amazon.awscdk.services.sqs

Class QueueBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.sqs.QueueBase

All Implemented Interfaces:

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

Direct Known Subclasses:

Queue

@Generated(value="jsii-pacmak/0.14.3 (build 1b1062d)",
           date="2019-08-02T10:16:28.751Z")
 @Stability(value=Stable)
public abstract class QueueBase
extends software.amazon.awscdk.core.Resource
implements IQueue

Reference to a new or existing 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
	QueueBase(software.amazon.awscdk.core.Construct scope, String id)
	QueueBase(software.amazon.awscdk.core.Construct scope, String id, software.amazon.awscdk.core.ResourceProps props)
protected	QueueBase(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
void	addToResourcePolicy(software.amazon.awscdk.services.iam.PolicyStatement statement) Adds a statement to the IAM resource policy associated with this queue.
protected Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
software.amazon.awscdk.services.kms.IKey	getEncryptionMasterKey() If this queue is server-side encrypted, this is the KMS encryption key.
String	getQueueArn() The ARN of this queue.
String	getQueueName() The name of this queue.
String	getQueueUrl() The URL of this queue.
software.amazon.awscdk.services.iam.Grant	grant(software.amazon.awscdk.services.iam.IGrantable grantee, String... actions) Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
software.amazon.awscdk.services.iam.Grant	grantConsumeMessages(software.amazon.awscdk.services.iam.IGrantable grantee) Grant permissions to consume messages from a queue.
software.amazon.awscdk.services.iam.Grant	grantPurge(software.amazon.awscdk.services.iam.IGrantable grantee) Grant an IAM principal permissions to purge all messages from the queue.
software.amazon.awscdk.services.iam.Grant	grantSendMessages(software.amazon.awscdk.services.iam.IGrantable grantee) Grant access to send messages to a queue to the given identity.
software.amazon.awscdk.services.cloudwatch.Metric	metric(String metricName) Return the given named metric for this Queue.
software.amazon.awscdk.services.cloudwatch.Metric	metric(String metricName, software.amazon.awscdk.services.cloudwatch.MetricOptions props) Return the given named metric for this Queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateAgeOfOldestMessage() The approximate age of the oldest non-deleted message in the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateAgeOfOldestMessage(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The approximate age of the oldest non-deleted message in the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesDelayed() The number of messages in the queue that are delayed and not available for reading immediately.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesDelayed(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages in the queue that are delayed and not available for reading immediately.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesNotVisible() The number of messages that are in flight.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesNotVisible(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages that are in flight.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesVisible() The number of messages available for retrieval from the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricApproximateNumberOfMessagesVisible(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages available for retrieval from the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfEmptyReceives() The number of ReceiveMessage API calls that did not return a message.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfEmptyReceives(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of ReceiveMessage API calls that did not return a message.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesDeleted() The number of messages deleted from the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesDeleted(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages deleted from the queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesReceived() The number of messages returned by calls to the ReceiveMessage action.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesReceived(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages returned by calls to the ReceiveMessage action.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesSent() The number of messages added to a queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricNumberOfMessagesSent(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The number of messages added to a queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricSentMessageSize() The size of messages added to a queue.
software.amazon.awscdk.services.cloudwatch.Metric	metricSentMessageSize(software.amazon.awscdk.services.cloudwatch.MetricOptions props) The size of messages added to a queue.

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

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

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

QueueBase

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

QueueBase

@Stability(value=Stable)
public QueueBase(software.amazon.awscdk.core.Construct scope,
                                          String id,
                                          @Nullable
                                          software.amazon.awscdk.core.ResourceProps props)

QueueBase

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

Method Detail

addToResourcePolicy

@Stability(value=Stable)
public void addToResourcePolicy(software.amazon.awscdk.services.iam.PolicyStatement statement)

Adds a statement to the IAM resource policy associated with this queue. If this queue was created in this stack (`new Queue`), a queue policy will be automatically created upon the first call to `addToPolicy`. If the queue is improted (`Queue.import`), then this is a no-op.

Specified by:

addToResourcePolicy in interface IQueue

grant

@Stability(value=Stable)
public software.amazon.awscdk.services.iam.Grant grant(software.amazon.awscdk.services.iam.IGrantable grantee,
                                                                                String... actions)

Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

Specified by:

grant in interface IQueue

Parameters:

grantee - Principal to grant right to.

actions - The actions to grant.

grantConsumeMessages

@Stability(value=Stable)
public software.amazon.awscdk.services.iam.Grant grantConsumeMessages(software.amazon.awscdk.services.iam.IGrantable grantee)

Grant permissions to consume messages from a queue. This will grant the following permissions: - sqs:ChangeMessageVisibility - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

Specified by:

grantConsumeMessages in interface IQueue

Parameters:

grantee - Principal to grant consume rights to.

grantPurge

@Stability(value=Stable)
public software.amazon.awscdk.services.iam.Grant grantPurge(software.amazon.awscdk.services.iam.IGrantable grantee)

Grant an IAM principal permissions to purge all messages from the queue. This will grant the following permissions: - sqs:PurgeQueue - sqs:GetQueueAttributes - sqs:GetQueueUrl

Specified by:

grantPurge in interface IQueue

Parameters:

grantee - Principal to grant send rights to.

grantSendMessages

@Stability(value=Stable)
public software.amazon.awscdk.services.iam.Grant grantSendMessages(software.amazon.awscdk.services.iam.IGrantable grantee)

Grant access to send messages to a queue to the given identity. This will grant the following permissions: - sqs:SendMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

Specified by:

grantSendMessages in interface IQueue

Parameters:

grantee - Principal to grant send rights to.

metric

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metric(String metricName,
                                                                                         @Nullable
                                                                                         software.amazon.awscdk.services.cloudwatch.MetricOptions props)

Return the given named metric for this Queue.

Specified by:

metric in interface IQueue

metric

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metric(String metricName)

Return the given named metric for this Queue.

Specified by:

metric in interface IQueue

metricApproximateAgeOfOldestMessage

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateAgeOfOldestMessage(@Nullable
                                                                                                                      software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The approximate age of the oldest non-deleted message in the queue. Maximum over 5 minutes

Specified by:

metricApproximateAgeOfOldestMessage in interface IQueue

metricApproximateAgeOfOldestMessage

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateAgeOfOldestMessage()

The approximate age of the oldest non-deleted message in the queue. Maximum over 5 minutes

Specified by:

metricApproximateAgeOfOldestMessage in interface IQueue

metricApproximateNumberOfMessagesDelayed

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesDelayed(@Nullable
                                                                                                                           software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages in the queue that are delayed and not available for reading immediately. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesDelayed in interface IQueue

metricApproximateNumberOfMessagesDelayed

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesDelayed()

The number of messages in the queue that are delayed and not available for reading immediately. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesDelayed in interface IQueue

metricApproximateNumberOfMessagesNotVisible

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesNotVisible(@Nullable
                                                                                                                              software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages that are in flight. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue

metricApproximateNumberOfMessagesNotVisible

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesNotVisible()

The number of messages that are in flight. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue

metricApproximateNumberOfMessagesVisible

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesVisible(@Nullable
                                                                                                                           software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages available for retrieval from the queue. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesVisible in interface IQueue

metricApproximateNumberOfMessagesVisible

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesVisible()

The number of messages available for retrieval from the queue. Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesVisible in interface IQueue

metricNumberOfEmptyReceives

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfEmptyReceives(@Nullable
                                                                                                              software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of ReceiveMessage API calls that did not return a message. Sum over 5 minutes

Specified by:

metricNumberOfEmptyReceives in interface IQueue

metricNumberOfEmptyReceives

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfEmptyReceives()

The number of ReceiveMessage API calls that did not return a message. Sum over 5 minutes

Specified by:

metricNumberOfEmptyReceives in interface IQueue

metricNumberOfMessagesDeleted

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesDeleted(@Nullable
                                                                                                                software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages deleted from the queue. Sum over 5 minutes

Specified by:

metricNumberOfMessagesDeleted in interface IQueue

metricNumberOfMessagesDeleted

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesDeleted()

The number of messages deleted from the queue. Sum over 5 minutes

Specified by:

metricNumberOfMessagesDeleted in interface IQueue

metricNumberOfMessagesReceived

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesReceived(@Nullable
                                                                                                                 software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages returned by calls to the ReceiveMessage action. Sum over 5 minutes

Specified by:

metricNumberOfMessagesReceived in interface IQueue

metricNumberOfMessagesReceived

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesReceived()

The number of messages returned by calls to the ReceiveMessage action. Sum over 5 minutes

Specified by:

metricNumberOfMessagesReceived in interface IQueue

metricNumberOfMessagesSent

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesSent(@Nullable
                                                                                                             software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The number of messages added to a queue. Sum over 5 minutes

Specified by:

metricNumberOfMessagesSent in interface IQueue

metricNumberOfMessagesSent

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesSent()

The number of messages added to a queue. Sum over 5 minutes

Specified by:

metricNumberOfMessagesSent in interface IQueue

metricSentMessageSize

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricSentMessageSize(@Nullable
                                                                                                        software.amazon.awscdk.services.cloudwatch.MetricOptions props)

The size of messages added to a queue. Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue

metricSentMessageSize

@Stability(value=Stable)
public software.amazon.awscdk.services.cloudwatch.Metric metricSentMessageSize()

The size of messages added to a queue. Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue

getAutoCreatePolicy

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

Controls automatic creation of policy objects. Set by subclasses.

getQueueArn

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

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

getQueueName

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

The name of this queue.

Specified by:

getQueueName in interface IQueue

getQueueUrl

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

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

getEncryptionMasterKey

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

If this queue is server-side encrypted, this is the KMS encryption key.

Specified by:

getEncryptionMasterKey in interface IQueue