Package software.amazon.awscdk.services.sqs

Class CfnQueueInlinePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sqs.CfnQueueInlinePolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.180Z")
@Stability(Stable)
public class CfnQueueInlinePolicy
extends CfnResource
implements IInspectable

The AWS::SQS::QueueInlinePolicy resource associates one Amazon SQS queue with one policy.

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;
 CfnQueueInlinePolicy cfnQueueInlinePolicy = CfnQueueInlinePolicy.Builder.create(this, "MyCfnQueueInlinePolicy")
         .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	Class	Description
static final class	CfnQueueInlinePolicy.Builder	A fluent builder for CfnQueueInlinePolicy.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyDocument(Object value)	A policy document that contains the permissions for the specified Amazon SQS queues.
void	setQueue(String value)	The URLs of the queues to which you want to add the policy.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnQueueInlinePolicy

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

CfnQueueInlinePolicy

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

CfnQueueInlinePolicy

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPolicyDocument

@Stability(Stable)
@NotNull
public Object getPolicyDocument()

A policy document that contains the permissions for the specified Amazon SQS queues.

setPolicyDocument

@Stability(Stable)
public void setPolicyDocument(@NotNull
 Object value)

A policy document that contains the permissions for the specified Amazon SQS queues.

getQueue

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

The URLs of the queues to which you want to add the policy.

setQueue

@Stability(Stable)
public void setQueue(@NotNull
 String value)

The URLs of the queues to which you want to add the policy.