Package software.amazon.awscdk.cfnpropertymixins.services.sqs

Interface CfnQueuePolicyMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueuePolicyMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.666Z")
@Stability(Stable)
public interface CfnQueuePolicyMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnQueuePolicyPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sqs.*;
 Object policyDocument;
 CfnQueuePolicyMixinProps cfnQueuePolicyMixinProps = CfnQueuePolicyMixinProps.builder()
         .policyDocument(policyDocument)
         .queues(List.of("queues"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQueuePolicyMixinProps.Builder	A builder for CfnQueuePolicyMixinProps
static final class	CfnQueuePolicyMixinProps.Jsii$Proxy	An implementation for CfnQueuePolicyMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnQueuePolicyMixinProps.Builder	builder()
default Object	getPolicyDocument()	A policy document that contains the permissions for the specified Amazon SQS queues.
default List<String>	getQueues()	The URLs of the queues to which you want to add the policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@Nullable
default Object getPolicyDocument()

A policy document that contains the permissions for the specified Amazon SQS queues.

For more information about Amazon SQS policies, see Using custom policies with the Amazon SQS access policy language in the Amazon SQS Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html#cfn-sqs-queuepolicy-policydocument

getQueues

@Stability(Stable)
@Nullable
default List<String> getQueues()

The URLs of the queues to which you want to add the policy.

You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html) resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queuepolicy.html#cfn-sqs-queuepolicy-queues

builder

@Stability(Stable)
static CfnQueuePolicyMixinProps.Builder builder()

Returns:

a CfnQueuePolicyMixinProps.Builder of CfnQueuePolicyMixinProps