software.amazon.awscdk.services.sqs

Class QueuePolicy

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.986Z")
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 and Description
static class	QueuePolicy.Builder A fluent builder for QueuePolicy.

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PolicyDocument	getDocument() The IAM policy document for this policy.
java.lang.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 java.lang.Object

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

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

getNode

Constructor Detail

QueuePolicy

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

QueuePolicy

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

QueuePolicy

public QueuePolicy(software.constructs.Construct scope,
                   java.lang.String id,
                   QueuePolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getDocument

public PolicyDocument getDocument()

The IAM policy document for this policy.

getQueuePolicyId

public java.lang.String getQueuePolicyId()

Not currently supported by AWS CloudFormation.

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