aws-cdk-lib.aws_sqs.QueuePolicy

class QueuePolicy (construct)

LanguageType name
.NETAmazon.CDK.AWS.SQS.QueuePolicy
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssqs#QueuePolicy
Javasoftware.amazon.awscdk.services.sqs.QueuePolicy
Pythonaws_cdk.aws_sqs.QueuePolicy
TypeScript (source)aws-cdk-lib » aws_sqs » QueuePolicy

Implements IConstruct, IDependable, IResource

The policy for an SQS Queue.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

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';

declare const queue: sqs.Queue;
const queuePolicy = new sqs.QueuePolicy(this, 'MyQueuePolicy', {
  queues: [queue],
});

Initializer

new QueuePolicy(scope: Construct, id: string, props: QueuePolicyProps)

Parameters

  • scope Construct
  • id string
  • props QueuePolicyProps

Construct Props

NameTypeDescription
queuesIQueue[]The set of queues this policy applies to.

queues

Type: IQueue[]

The set of queues this policy applies to.

Properties

NameTypeDescription
documentPolicyDocumentThe IAM policy document for this policy.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
queuePolicyIdstringNot currently supported by AWS CloudFormation.
stackStackThe stack in which this resource is defined.

document

Type: PolicyDocument

The IAM policy document for this policy.


env

Type: ResourceEnvironment

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.


node

Type: Node

The tree node.


queuePolicyId

Type: string

Not currently supported by AWS CloudFormation.

This attribute temporarily existed in CloudFormation, and then was removed again.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.