software.amazon.awscdk.services.sqs

Interface IQueue

All Superinterfaces:

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

All Known Subinterfaces:

IQueue.Jsii$Default

All Known Implementing Classes:

IQueue.Jsii$Proxy, Queue, QueueBase

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:16.504Z")
 @Stability(value=Stable)
public interface IQueue
extends software.amazon.jsii.JsiiSerializable, IResource

Represents an SQS queue.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IQueue.Jsii$Default Internal default implementation for IQueue.
static class	IQueue.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Adds a statement to the IAM resource policy associated with this queue.
default IKey	getEncryptionMasterKey() If this queue is server-side encrypted, this is the KMS encryption 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.
Grant	grant(IGrantable grantee, String... queueActions) 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 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

Method Detail

getFifo

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

Whether this queue is an Amazon SQS FIFO queue.

If false, this is a standard queue.

getQueueArn

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

The ARN of this queue.

getQueueName

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

The name of this queue.

getQueueUrl

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

The URL of this queue.

getEncryptionMasterKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionMasterKey()

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

addToResourcePolicy

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

Parameters:

statement - This parameter is required.

grant

@Stability(value=Stable)
 @NotNull
Grant grant(@NotNull
                                               IGrantable grantee,
                                               @NotNull
                                               String... queueActions)

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

Parameters:

grantee - Principal to grant right to. This parameter is required.

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

grantConsumeMessages

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

Parameters:

grantee - Principal to grant consume rights to. This parameter is required.

grantPurge

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

Parameters:

grantee - Principal to grant send rights to. This parameter is required.

grantSendMessages

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

Parameters:

grantee - Principal to grant send rights to. This parameter is required.

metric

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

Return the given named metric for this Queue.

Parameters:

metricName - This parameter is required.

props -

metric

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

Return the given named metric for this Queue.

Parameters:

metricName - This parameter is required.

metricApproximateAgeOfOldestMessage

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

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

Maximum over 5 minutes

Parameters:

props -

metricApproximateAgeOfOldestMessage

@Stability(value=Stable)
 @NotNull
Metric metricApproximateAgeOfOldestMessage()

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

Maximum over 5 minutes

metricApproximateNumberOfMessagesDelayed

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

Parameters:

props -

metricApproximateNumberOfMessagesDelayed

@Stability(value=Stable)
 @NotNull
Metric metricApproximateNumberOfMessagesDelayed()

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

Maximum over 5 minutes

metricApproximateNumberOfMessagesNotVisible

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

The number of messages that are in flight.

Maximum over 5 minutes

Parameters:

props -

metricApproximateNumberOfMessagesNotVisible

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

The number of messages that are in flight.

Maximum over 5 minutes

metricApproximateNumberOfMessagesVisible

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

The number of messages available for retrieval from the queue.

Maximum over 5 minutes

Parameters:

props -

metricApproximateNumberOfMessagesVisible

@Stability(value=Stable)
 @NotNull
Metric metricApproximateNumberOfMessagesVisible()

The number of messages available for retrieval from the queue.

Maximum over 5 minutes

metricNumberOfEmptyReceives

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

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfEmptyReceives

@Stability(value=Stable)
 @NotNull
Metric metricNumberOfEmptyReceives()

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

Sum over 5 minutes

metricNumberOfMessagesDeleted

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

The number of messages deleted from the queue.

Sum over 5 minutes

Parameters:

props -

metricNumberOfMessagesDeleted

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

The number of messages deleted from the queue.

Sum over 5 minutes

metricNumberOfMessagesReceived

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

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfMessagesReceived

@Stability(value=Stable)
 @NotNull
Metric metricNumberOfMessagesReceived()

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

Sum over 5 minutes

metricNumberOfMessagesSent

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

The number of messages added to a queue.

Sum over 5 minutes

Parameters:

props -

metricNumberOfMessagesSent

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

The number of messages added to a queue.

Sum over 5 minutes

metricSentMessageSize

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

The size of messages added to a queue.

Average over 5 minutes

Parameters:

props -

metricSentMessageSize

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

The size of messages added to a queue.

Average over 5 minutes