Package software.amazon.awscdk.services.sqs

Interface CfnQueueInlinePolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueueInlinePolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.181Z")
@Stability(Stable)
public interface CfnQueueInlinePolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueueInlinePolicy.

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;
 CfnQueueInlinePolicyProps cfnQueueInlinePolicyProps = CfnQueueInlinePolicyProps.builder()
         .policyDocument(policyDocument)
         .queue("queue")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnQueueInlinePolicyProps.Builder	builder()
Object	getPolicyDocument()	A policy document that contains the permissions for the specified Amazon SQS queues.
String	getQueue()	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-queueinlinepolicy.html#cfn-sqs-queueinlinepolicy-policydocument

getQueue

@Stability(Stable)
@NotNull
String getQueue()

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-queueinlinepolicy.html#cfn-sqs-queueinlinepolicy-queue

builder

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

Returns:

a CfnQueueInlinePolicyProps.Builder of CfnQueueInlinePolicyProps