Package software.amazon.awscdk.services.sns

Class CfnTopicPolicy

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.CfnTopicPolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:45.964Z")
@Stability(Stable)
public class CfnTopicPolicy
extends CfnResource
implements IInspectable, ITopicPolicyRef

The AWS::SNS::TopicPolicy resource associates Amazon topics with a policy.

For an example snippet, see Declaring an Amazon policy in the CloudFormation User Guide .

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;
 CfnTopicPolicy cfnTopicPolicy = CfnTopicPolicy.Builder.create(this, "MyCfnTopicPolicy")
         .policyDocument(policyDocument)
         .topics(List.of("topics"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.sns.ITopicPolicyRef

ITopicPolicyRef.Jsii$Default, ITopicPolicyRef.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	CfnTopicPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopicPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTopicPolicy(software.constructs.Construct scope, String id, CfnTopicPolicyProps props)	Create a new AWS::SNS::TopicPolicy.

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The provider-assigned unique ID for this managed resource.
protected Map<String,Object>	getCfnProperties()
Object	getPolicyDocument()	A policy document that contains permissions to add to the specified SNS topics.
TopicPolicyReference	getTopicPolicyRef()	A reference to a TopicPolicy resource.
List<String>	getTopics()	The Amazon Resource Names (ARN) of the topics to which you want to add the policy.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnTopicPolicy(Object x)	Checks whether the given object is a CfnTopicPolicy.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyDocument(Object value)	A policy document that contains permissions to add to the specified SNS topics.
void	setTopics(List<String> value)	The Amazon Resource Names (ARN) of the topics 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, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

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

CfnTopicPolicy

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

CfnTopicPolicy

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

CfnTopicPolicy

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

Create a new AWS::SNS::TopicPolicy.

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

isCfnTopicPolicy

@Stability(Stable)
@NotNull
public static Boolean isCfnTopicPolicy(@NotNull
 Object x)

Checks whether the given object is a CfnTopicPolicy.

Parameters:

x - This parameter is required.

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.

getAttrId

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

The provider-assigned unique ID for this managed resource.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTopicPolicyRef

@Stability(Stable)
@NotNull
public TopicPolicyReference getTopicPolicyRef()

A reference to a TopicPolicy resource.

Specified by:

getTopicPolicyRef in interface ITopicPolicyRef

getPolicyDocument

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

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

setPolicyDocument

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

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

getTopics

@Stability(Stable)
@NotNull
public List<String> getTopics()

The Amazon Resource Names (ARN) of the topics to which you want to add the policy.

setTopics

@Stability(Stable)
public void setTopics(@NotNull
 List<String> value)

The Amazon Resource Names (ARN) of the topics to which you want to add the policy.