software.amazon.awscdk.services.sqs

Interface IQueue

All Superinterfaces:

software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination, software.amazon.awscdk.IConstruct, 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.13 (build 311bf88)",
           date="2019-01-11T10:50:56.003Z")
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	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.

Methods inherited from interface software.amazon.awscdk.IConstruct

getNode

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

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