Package software.amazon.awscdk.services.sqs

Class QueuePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.sqs.QueuePolicy

All Implemented Interfaces:

IConstruct, IDependable, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.045Z")
@Stability(Stable)
public class QueuePolicy
extends Resource

The policy for an SQS Queue.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

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.*;
 Queue queue;
 QueuePolicy queuePolicy = QueuePolicy.Builder.create(this, "MyQueuePolicy")
         .queues(List.of(queue))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QueuePolicy.Builder	A fluent builder for QueuePolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueuePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	QueuePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	QueuePolicy(software.constructs.Construct scope, String id, QueuePolicyProps props)

Method Summary

Modifier and Type	Method	Description
PolicyDocument	getDocument()	The IAM policy document for this policy.
String	getQueuePolicyId()	Not currently supported by AWS CloudFormation.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

QueuePolicy

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

QueuePolicy

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

QueuePolicy

@Stability(Stable)
public QueuePolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 QueuePolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getDocument

@Stability(Stable)
@NotNull
public PolicyDocument getDocument()

The IAM policy document for this policy.

getQueuePolicyId

@Stability(Stable)
@NotNull
public String getQueuePolicyId()

Not currently supported by AWS CloudFormation.

This attribute temporarily existed in CloudFormation, and then was removed again.