class QueueGrants

Language	Type name
.NET	Amazon.CDK.AWS.SQS.QueueGrants
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssqs#QueueGrants
Java	software.amazon.awscdk.services.sqs.QueueGrants
Python	aws_cdk.aws_sqs.QueueGrants
TypeScript	aws-cdk-lib » aws_sqs » QueueGrants

Collection of grant methods for a IQueueRef.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sqs as sqs } from 'aws-cdk-lib';
import { aws_sqs as interfaces_aws_sqs } from 'aws-cdk-lib/interfaces';

declare const queueRef: interfaces_aws_sqs.IQueueRef;
const queueGrants = sqs.QueueGrants.fromQueue(queueRef);

Properties

Name	Type	Description
resource	IQueueRef
encryptedResource?	IEncryptedResource
policyResource?	IResourceWithPolicyV2

---

resource

Type: IQueueRef

---

encryptedResource?

Type: IEncryptedResource (optional)

---

policyResource?

Type: IResourceWithPolicyV2 (optional)

Methods

Name	Description
consumeMessages(grantee)	Grant permissions to consume messages from a queue.
purge(grantee)	Grants purge permissions.
sendMessages(grantee)	Grant access to send messages to a queue to the given identity.
static fromQueue(resource)	Creates grants for QueueGrants.

---

consumeMessages(grantee)

public consumeMessages(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant permissions to consume messages from a queue.

This will grant the following permissions:

• sqs:ChangeMessageVisibility
• sqs:DeleteMessage
• sqs:ReceiveMessage
• sqs:GetQueueAttributes
• sqs:GetQueueUrl

If encryption is used, permission to use the key to decrypt the contents of the queue will also be granted to the same principal.

This will grant the following KMS permissions:

• kms:Decrypt

---

purge(grantee)

public purge(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants purge permissions.

---

sendMessages(grantee)

public sendMessages(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant access to send messages to a queue to the given identity.

This will grant the following permissions:

• sqs:SendMessage
• sqs:GetQueueAttributes
• sqs:GetQueueUrl

If encryption is used, permission to use the key to encrypt/decrypt the contents of the queue will also be granted to the same principal.

This will grant the following KMS permissions:

• kms:Decrypt
• kms:Encrypt
• kms:ReEncrypt*
• kms:GenerateDataKey*

---

static fromQueue(resource)

public static fromQueue(resource: IQueueRef): QueueGrants

Parameters

• resource IQueueRef

Returns

• QueueGrants

Creates grants for QueueGrants.