Class QueuePolicy

All Implemented Interfaces:
IConstruct, IDependable, IResource,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.045Z") @Stability(Stable) public class QueuePolicy extends Resource
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.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Queue queue;
 QueuePolicy queuePolicy = QueuePolicy.Builder.create(this, "MyQueuePolicy")
  • Constructor Details

    • QueuePolicy

      protected QueuePolicy( objRef)
    • QueuePolicy

      protected QueuePolicy( initializationMode)
    • QueuePolicy

      @Stability(Stable) public QueuePolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull QueuePolicyProps props)
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • getDocument

      @Stability(Stable) @NotNull public PolicyDocument getDocument()
      The IAM policy document for this policy.
    • getQueuePolicyId

      @Stability(Stable) @NotNull public String getQueuePolicyId()
      Not currently supported by AWS CloudFormation.

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