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:

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

Enclosing interface:

IQueue

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

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$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

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.
software.amazon.awscdk.services.s3.notifications.BucketNotificationDestinationProps	asBucketNotificationDestination(String bucketArn, String bucketId) Registers this resource to receive notifications for the specified bucket.
software.amazon.awscdk.services.autoscaling.api.LifecycleHookTargetProps	asLifecycleHookTarget(software.amazon.awscdk.services.autoscaling.api.ILifecycleHook lifecycleHook) Called when this object is used as the target of a lifecycle hook
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.
software.amazon.awscdk.ConstructNode	getNode() The construct node in the scope tree.
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 class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Detail

getQueueArn

public String getQueueArn()

The ARN of this queue

Specified by:

getQueueArn in interface IQueue

getQueueUrl

public String getQueueUrl()

The URL of this queue

Specified by:

getQueueUrl in interface IQueue

getEncryptionMasterKey

@Nullable
public software.amazon.awscdk.services.kms.IEncryptionKey getEncryptionMasterKey()

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

Specified by:

getEncryptionMasterKey in interface IQueue

getNode

public software.amazon.awscdk.ConstructNode getNode()

The construct node in the scope tree.

Specified by:

getNode in interface software.amazon.awscdk.IConstruct

addToResourcePolicy

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

Specified by:

addToResourcePolicy in interface IQueue

export

public QueueImportProps export()

Export a queue

Specified by:

export in interface IQueue

grant

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

Specified by:

grant in interface IQueue

Parameters:

identity - Principal to grant right to

queueActions - The actions to grant

grantConsumeMessages

public 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

Specified by:

grantConsumeMessages in interface IQueue

Parameters:

identity - Principal to grant consume rights to

grantConsumeMessages

public 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

Specified by:

grantConsumeMessages in interface IQueue

grantPurge

public 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

Specified by:

grantPurge in interface IQueue

Parameters:

identity - Principal to grant send rights to

grantPurge

public 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

Specified by:

grantPurge in interface IQueue

grantSendMessages

public 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

Specified by:

grantSendMessages in interface IQueue

Parameters:

identity - Principal to grant send rights to

grantSendMessages

public 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

Specified by:

grantSendMessages in interface IQueue

asBucketNotificationDestination

public software.amazon.awscdk.services.s3.notifications.BucketNotificationDestinationProps asBucketNotificationDestination(String bucketArn,
                                                                                                                           String bucketId)

Registers this resource to receive notifications for the specified bucket. This method will only be called once for each destination/bucket pair and the result will be cached, so there is no need to implement idempotency in each destination.

Specified by:

asBucketNotificationDestination in interface software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination

Parameters:

bucketArn - The ARN of the bucket

bucketId - A unique ID of this bucket in the stack

asLifecycleHookTarget

public software.amazon.awscdk.services.autoscaling.api.LifecycleHookTargetProps asLifecycleHookTarget(software.amazon.awscdk.services.autoscaling.api.ILifecycleHook lifecycleHook)

Called when this object is used as the target of a lifecycle hook

Specified by:

asLifecycleHookTarget in interface software.amazon.awscdk.services.autoscaling.api.ILifecycleHookTarget