software.amazon.awscdk.services.sqs

Interface IQueue

All Superinterfaces:

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

All Known Implementing Classes:

IQueue.Jsii$Proxy, Queue, QueueBase

@Generated(value="jsii-pacmak/0.7.15 (build e429c41)",
           date="2019-03-07T22:16:52.936Z")
public interface IQueue
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.IConstruct, software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination, software.amazon.awscdk.services.autoscaling.api.ILifecycleHookTarget

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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
void	addToResourcePolicy(software.amazon.awscdk.services.iam.PolicyStatement statement) Adds a statement to the IAM resource policy associated with this queue.
QueueImportProps	export() Export a queue
software.amazon.awscdk.services.kms.IEncryptionKey	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
void	grant(software.amazon.awscdk.services.iam.IPrincipal identity, String... queueActions) Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.
void	grantConsumeMessages() Grant permissions to consume messages from a queue This will grant the following permissions: - sqs:ChangeMessageVisibility - sqs:ChangeMessageVisibilityBatch - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:DeleteMessageBatch - sqs:GetQueueAttributes - sqs:GetQueueUrl
void	grantConsumeMessages(software.amazon.awscdk.services.iam.IPrincipal identity) Grant permissions to consume messages from a queue This will grant the following permissions: - sqs:ChangeMessageVisibility - sqs:ChangeMessageVisibilityBatch - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:DeleteMessageBatch - sqs:GetQueueAttributes - sqs:GetQueueUrl
void	grantPurge() Grant an IAM principal permissions to purge all messages from the queue.
void	grantPurge(software.amazon.awscdk.services.iam.IPrincipal identity) Grant an IAM principal permissions to purge all messages from the queue.
void	grantSendMessages() Grant access to send messages to a queue to the given identity.
void	grantSendMessages(software.amazon.awscdk.services.iam.IPrincipal identity) 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization 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.MetricCustomization props) The size of messages added to a queue.

Methods inherited from interface software.amazon.awscdk.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IDependable

getDependencyRoots

Methods inherited from interface software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination

asBucketNotificationDestination

Methods inherited from interface software.amazon.awscdk.services.autoscaling.api.ILifecycleHookTarget

asLifecycleHookTarget

Method Detail

getQueueArn

String getQueueArn()

The ARN of this queue

getQueueName

String getQueueName()

The name of this queue

getQueueUrl

String getQueueUrl()

The URL of this queue

getEncryptionMasterKey

software.amazon.awscdk.services.kms.IEncryptionKey getEncryptionMasterKey()

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

addToResourcePolicy

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.

export

QueueImportProps export()

Export a queue

grant

void grant(@Nullable
           software.amazon.awscdk.services.iam.IPrincipal identity,
           String... queueActions)

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

Parameters:

identity - Principal to grant right to

queueActions - The actions to grant

grantConsumeMessages

void grantConsumeMessages(@Nullable
                          software.amazon.awscdk.services.iam.IPrincipal identity)

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

Parameters:

identity - Principal to grant consume rights to

grantConsumeMessages

void grantConsumeMessages()

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

grantPurge

void grantPurge(@Nullable
                software.amazon.awscdk.services.iam.IPrincipal identity)

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:

identity - Principal to grant send rights to

grantPurge

void grantPurge()

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

grantSendMessages

void grantSendMessages(@Nullable
                       software.amazon.awscdk.services.iam.IPrincipal identity)

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

Parameters:

identity - Principal to grant send rights to

grantSendMessages

void grantSendMessages()

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

metric

software.amazon.awscdk.services.cloudwatch.Metric metric(String metricName,
                                                         @Nullable
                                                         software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Return the given named metric for this Queue

metric

software.amazon.awscdk.services.cloudwatch.Metric metric(String metricName)

Return the given named metric for this Queue

metricApproximateAgeOfOldestMessage

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateAgeOfOldestMessage(@Nullable
                                                                                      software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricApproximateAgeOfOldestMessage

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateAgeOfOldestMessage()

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

metricApproximateNumberOfMessagesDelayed

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesDelayed(@Nullable
                                                                                           software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricApproximateNumberOfMessagesDelayed

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

metricApproximateNumberOfMessagesNotVisible

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesNotVisible(@Nullable
                                                                                              software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricApproximateNumberOfMessagesNotVisible

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesNotVisible()

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

metricApproximateNumberOfMessagesVisible

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesVisible(@Nullable
                                                                                           software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricApproximateNumberOfMessagesVisible

software.amazon.awscdk.services.cloudwatch.Metric metricApproximateNumberOfMessagesVisible()

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

metricNumberOfEmptyReceives

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfEmptyReceives(@Nullable
                                                                              software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricNumberOfEmptyReceives

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfEmptyReceives()

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

metricNumberOfMessagesDeleted

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesDeleted(@Nullable
                                                                                software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricNumberOfMessagesDeleted

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesDeleted()

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

metricNumberOfMessagesReceived

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesReceived(@Nullable
                                                                                 software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricNumberOfMessagesReceived

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesReceived()

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

metricNumberOfMessagesSent

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesSent(@Nullable
                                                                             software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricNumberOfMessagesSent

software.amazon.awscdk.services.cloudwatch.Metric metricNumberOfMessagesSent()

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

metricSentMessageSize

software.amazon.awscdk.services.cloudwatch.Metric metricSentMessageSize(@Nullable
                                                                        software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

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

metricSentMessageSize

software.amazon.awscdk.services.cloudwatch.Metric metricSentMessageSize()

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