Package software.amazon.awscdk.services.sqs

Interface CfnQueuePolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueuePolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.088Z")
@Stability(Stable)
public interface CfnQueuePolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueuePolicy.

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;
 CfnQueuePolicyProps cfnQueuePolicyProps = CfnQueuePolicyProps.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	CfnQueuePolicyProps.Builder	A builder for CfnQueuePolicyProps
static final class	CfnQueuePolicyProps.Jsii$Proxy	An implementation for CfnQueuePolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnQueuePolicyProps.Builder	builder()
Object	getPolicyDocument()	A policy document that contains the permissions for the specified Amazon SQS queues.
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)
@NotNull
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)
@NotNull
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-properties-sqs-queues.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 CfnQueuePolicyProps.Builder builder()

Returns:

a CfnQueuePolicyProps.Builder of CfnQueuePolicyProps