software.amazon.awscdk.services.sqs

Class CfnQueuePolicy.Builder

java.lang.Object

software.amazon.awscdk.services.sqs.CfnQueuePolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnQueuePolicy>

Enclosing class:

CfnQueuePolicy

@Stability(value=Stable)
public static final class CfnQueuePolicy.Builder
extends Object
implements software.amazon.jsii.Builder<CfnQueuePolicy>

A fluent builder for CfnQueuePolicy.

Method Summary

Modifier and Type	Method and Description
CfnQueuePolicy	build()
static CfnQueuePolicy.Builder	create(software.constructs.Construct scope, String id)
CfnQueuePolicy.Builder	policyDocument(Object policyDocument) A policy document that contains the permissions for the specified Amazon SQS queues.
CfnQueuePolicy.Builder	queues(List<String> queues) The URLs of the queues to which you want to add the policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnQueuePolicy.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnQueuePolicy.Builder.

policyDocument

@Stability(value=Stable)
public CfnQueuePolicy.Builder policyDocument(Object policyDocument)

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 .

Parameters:

policyDocument - A policy document that contains the permissions for the specified Amazon SQS queues. This parameter is required.

Returns:

this

queues

@Stability(value=Stable)
public CfnQueuePolicy.Builder queues(List<String> queues)

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.

Parameters:

queues - The URLs of the queues to which you want to add the policy. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnQueuePolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnQueuePolicy>