Package software.amazon.awscdk.services.sns

Class CfnTopicInlinePolicy

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.sns.CfnTopicInlinePolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-11T03:46:01.759Z")
@Stability(Stable)
public class CfnTopicInlinePolicy
extends CfnResource
implements IInspectable

The AWS::SNS::TopicInlinePolicy resource associates one Amazon SNS topic 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.sns.*;
 Object policyDocument;
 CfnTopicInlinePolicy cfnTopicInlinePolicy = CfnTopicInlinePolicy.Builder.create(this, "MyCfnTopicInlinePolicy")
         .policyDocument(policyDocument)
         .topicArn("topicArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicinlinepolicy.html

Nested Class Summary

Nested Classes

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

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	CfnTopicInlinePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopicInlinePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTopicInlinePolicy(software.constructs.Construct scope, String id, CfnTopicInlinePolicyProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getPolicyDocument()	A policy document that contains permissions to add to the specified Amazon SNS topic.
String	getTopicArn()	The Amazon Resource Name (ARN) of the topic 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 permissions to add to the specified Amazon SNS topic.
void	setTopicArn(String value)	The Amazon Resource Name (ARN) of the topic 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

CfnTopicInlinePolicy

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

CfnTopicInlinePolicy

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

CfnTopicInlinePolicy

@Stability(Stable)
public CfnTopicInlinePolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTopicInlinePolicyProps 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 permissions to add to the specified Amazon SNS topic.

setPolicyDocument

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

A policy document that contains permissions to add to the specified Amazon SNS topic.

getTopicArn

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

The Amazon Resource Name (ARN) of the topic to which you want to add the policy.

setTopicArn

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

The Amazon Resource Name (ARN) of the topic to which you want to add the policy.