software.amazon.awscdk.services.sqs

Class IQueue.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sqs.IQueue.Jsii$Proxy

All Implemented Interfaces:

IResource, IResource.Jsii$Default, IQueue, IQueue.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IQueue

@Internal
public static final class IQueue.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IQueue.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

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, IQueue.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(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.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
IKey	getEncryptionMasterKey() If this queue is server-side encrypted, this is the KMS encryption key.
ResourceEnvironment	getEnv() The environment this resource belongs to.
Boolean	getFifo() Whether this queue is an Amazon SQS FIFO queue.
software.constructs.Node	getNode() The tree node.
String	getQueueArn() The ARN of this queue.
String	getQueueName() The name of this queue.
String	getQueueUrl() The URL of this queue.
Stack	getStack() The stack in which this resource is defined.
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 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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IQueue.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IQueue.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IQueue.Jsii$Default

getFifo

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

Whether this queue is an Amazon SQS FIFO queue.

If false, this is a standard queue.

Specified by:

getFifo in interface IQueue

Specified by:

getFifo in interface IQueue.Jsii$Default

getQueueArn

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

The ARN of this queue.

Specified by:

getQueueArn in interface IQueue

Specified by:

getQueueArn in interface IQueue.Jsii$Default

getQueueName

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

The name of this queue.

Specified by:

getQueueName in interface IQueue

Specified by:

getQueueName in interface IQueue.Jsii$Default

getQueueUrl

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

The URL of this queue.

Specified by:

getQueueUrl in interface IQueue

Specified by:

getQueueUrl in interface IQueue.Jsii$Default

getEncryptionMasterKey

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

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

Specified by:

getEncryptionMasterKey in interface IQueue

Specified by:

getEncryptionMasterKey in interface IQueue.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
public final void applyRemovalPolicy(@NotNull
                                                              RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IQueue.Jsii$Default

Parameters:

policy - This parameter is required.

addToResourcePolicy

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

Specified by:

addToResourcePolicy in interface IQueue.Jsii$Default

Parameters:

statement - This parameter is required.

grant

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

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

Specified by:

grant in interface IQueue

Specified by:

grant in interface IQueue.Jsii$Default

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
public final 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

Specified by:

grantConsumeMessages in interface IQueue.Jsii$Default

Parameters:

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

grantPurge

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

Specified by:

grantPurge in interface IQueue.Jsii$Default

Parameters:

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

grantSendMessages

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

Specified by:

grantSendMessages in interface IQueue.Jsii$Default

Parameters:

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

metric

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

Return the given named metric for this Queue.

Specified by:

metric in interface IQueue

Specified by:

metric in interface IQueue.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

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

Specified by:

metricApproximateAgeOfOldestMessage in interface IQueue.Jsii$Default

Parameters:

props -

metricApproximateAgeOfOldestMessage

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

Specified by:

metricApproximateNumberOfMessagesDelayed in interface IQueue.Jsii$Default

Parameters:

props -

metricApproximateNumberOfMessagesDelayed

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

The number of messages that are in flight.

Maximum over 5 minutes

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue

Specified by:

metricApproximateNumberOfMessagesNotVisible in interface IQueue.Jsii$Default

Parameters:

props -

metricApproximateNumberOfMessagesNotVisible

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

Specified by:

metricApproximateNumberOfMessagesVisible in interface IQueue.Jsii$Default

Parameters:

props -

metricApproximateNumberOfMessagesVisible

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

Specified by:

metricNumberOfEmptyReceives in interface IQueue.Jsii$Default

Parameters:

props -

metricNumberOfEmptyReceives

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

The number of messages deleted from the queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesDeleted in interface IQueue

Specified by:

metricNumberOfMessagesDeleted in interface IQueue.Jsii$Default

Parameters:

props -

metricNumberOfMessagesDeleted

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

Specified by:

metricNumberOfMessagesReceived in interface IQueue.Jsii$Default

Parameters:

props -

metricNumberOfMessagesReceived

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

The number of messages added to a queue.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesSent in interface IQueue

Specified by:

metricNumberOfMessagesSent in interface IQueue.Jsii$Default

Parameters:

props -

metricNumberOfMessagesSent

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

The size of messages added to a queue.

Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue

Specified by:

metricSentMessageSize in interface IQueue.Jsii$Default

Parameters:

props -

metricSentMessageSize

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

The size of messages added to a queue.

Average over 5 minutes

Specified by:

metricSentMessageSize in interface IQueue