software.amazon.awscdk.services.sqs

Class QueueBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sqs.QueueBase

All Implemented Interfaces:

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

Direct Known Subclasses:

Queue

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:16.519Z")
 @Stability(value=Stable)
public abstract class QueueBase
extends 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

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

IQueue.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

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

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

QueueBase

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

QueueBase

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

QueueBase

@Stability(value=Stable)
protected QueueBase(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

QueueBase

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addToResourcePolicy

@Stability(value=Stable)
 @NotNull
public AddToResourcePolicyResult addToResourcePolicy(@NotNull
                                                                                        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 imported (Queue.import), then this is a no-op.

Specified by:

addToResourcePolicy in interface IQueue

Parameters:

statement - This parameter is required.

grant

@Stability(value=Stable)
 @NotNull
public Grant grant(@NotNull
                                                      IGrantable grantee,
                                                      @NotNull
                                                      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. This parameter is required.

actions - The actions to grant. This parameter is required.

grantConsumeMessages

@Stability(value=Stable)
 @NotNull
public Grant grantConsumeMessages(@NotNull
                                                                     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. This parameter is required.

grantPurge

@Stability(value=Stable)
 @NotNull
public Grant grantPurge(@NotNull
                                                           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. This parameter is required.

grantSendMessages

@Stability(value=Stable)
 @NotNull
public Grant grantSendMessages(@NotNull
                                                                  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. This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)

Return the given named metric for this Queue.

Specified by:

metric in interface IQueue

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Return the given named metric for this Queue.

Specified by:

metric in interface IQueue

Parameters:

metricName - This parameter is required.

metricApproximateAgeOfOldestMessage

@Stability(value=Stable)
 @NotNull
public Metric metricApproximateAgeOfOldestMessage(@Nullable
                                                                                     MetricOptions props)

The approximate age of the oldest non-deleted message in the queue.

Maximum over 5 minutes

Specified by:

metricApproximateAgeOfOldestMessage in interface IQueue

Parameters:

props -

metricApproximateAgeOfOldestMessage

@Stability(value=Stable)
 @NotNull
public 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)
 @NotNull
public Metric metricApproximateNumberOfMessagesDelayed(@Nullable
                                                                                          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

Parameters:

props -

metricApproximateNumberOfMessagesDelayed

@Stability(value=Stable)
 @NotNull
public 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)
 @NotNull
public Metric metricApproximateNumberOfMessagesNotVisible(@Nullable
                                                                                             MetricOptions props)

The number of messages that are in flight.

Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue

Parameters:

props -

metricApproximateNumberOfMessagesNotVisible

@Stability(value=Stable)
 @NotNull
public Metric metricApproximateNumberOfMessagesNotVisible()

The number of messages that are in flight.

Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue

metricApproximateNumberOfMessagesVisible

@Stability(value=Stable)
 @NotNull
public Metric metricApproximateNumberOfMessagesVisible(@Nullable
                                                                                          MetricOptions props)

The number of messages available for retrieval from the queue.

Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesVisible in interface IQueue

Parameters:

props -

metricApproximateNumberOfMessagesVisible

@Stability(value=Stable)
 @NotNull
public 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)
 @NotNull
public Metric metricNumberOfEmptyReceives(@Nullable
                                                                             MetricOptions props)

The number of ReceiveMessage API calls that did not return a message.

Sum over 5 minutes

Specified by:

metricNumberOfEmptyReceives in interface IQueue

Parameters:

props -

metricNumberOfEmptyReceives

@Stability(value=Stable)
 @NotNull
public 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)
 @NotNull
public Metric metricNumberOfMessagesDeleted(@Nullable
                                                                               MetricOptions props)

The number of messages deleted from the queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesDeleted in interface IQueue

Parameters:

props -

metricNumberOfMessagesDeleted

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfMessagesDeleted()

The number of messages deleted from the queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesDeleted in interface IQueue

metricNumberOfMessagesReceived

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfMessagesReceived(@Nullable
                                                                                MetricOptions props)

The number of messages returned by calls to the ReceiveMessage action.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesReceived in interface IQueue

Parameters:

props -

metricNumberOfMessagesReceived

@Stability(value=Stable)
 @NotNull
public 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)
 @NotNull
public Metric metricNumberOfMessagesSent(@Nullable
                                                                            MetricOptions props)

The number of messages added to a queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesSent in interface IQueue

Parameters:

props -

metricNumberOfMessagesSent

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfMessagesSent()

The number of messages added to a queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesSent in interface IQueue

metricSentMessageSize

@Stability(value=Stable)
 @NotNull
public Metric metricSentMessageSize(@Nullable
                                                                       MetricOptions props)

The size of messages added to a queue.

Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue

Parameters:

props -

metricSentMessageSize

@Stability(value=Stable)
 @NotNull
public Metric metricSentMessageSize()

The size of messages added to a queue.

Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue

getAutoCreatePolicy

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

Controls automatic creation of policy objects.

Set by subclasses.

getFifo

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

Whether this queue is an Amazon SQS FIFO queue.

If false, this is a standard queue.

Specified by:

getFifo in interface IQueue

getQueueArn

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

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

getQueueName

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

The name of this queue.

Specified by:

getQueueName in interface IQueue

getQueueUrl

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

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

getEncryptionMasterKey

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

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

Specified by:

getEncryptionMasterKey in interface IQueue