Package software.amazon.awscdk.services.sqs

Class CfnQueuePolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sqs.CfnQueuePolicy
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IQueuePolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:15.550Z") @Stability(Stable) public class CfnQueuePolicy extends CfnResource implements IInspectable, IQueuePolicyRef
The AWS::SQS::QueuePolicy type applies a policy to Amazon SQS queues.

For an example snippet, see Declaring an Amazon SQS policy in the AWS CloudFormation User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sqs.*;
 Object policyDocument;
 CfnQueuePolicy cfnQueuePolicy = CfnQueuePolicy.Builder.create(this, "MyCfnQueuePolicy")
         .policyDocument(policyDocument)
         .queues(List.of("queues"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQueuePolicy

      protected CfnQueuePolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQueuePolicy

      protected CfnQueuePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQueuePolicy

      @Stability(Stable) public CfnQueuePolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnQueuePolicyProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The provider-assigned unique ID for this managed resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getQueuePolicyRef

      @Stability(Stable) @NotNull public QueuePolicyReference getQueuePolicyRef()
      A reference to a QueuePolicy resource.
      Specified by:
      getQueuePolicyRef in interface IQueuePolicyRef

    • getPolicyDocument

      @Stability(Stable) @NotNull public Object getPolicyDocument()
      A policy document that contains the permissions for the specified Amazon SQS queues.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@NotNull Object value)
      A policy document that contains the permissions for the specified Amazon SQS queues.

    • getQueues

      @Stability(Stable) @NotNull public List<String> getQueues()
      The URLs of the queues to which you want to add the policy.

    • setQueues

      @Stability(Stable) public void setQueues(@NotNull List<String> value)
      The URLs of the queues to which you want to add the policy.