Package software.amazon.awscdk.services.sns

Interface CfnTopicPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:25:05.770Z")
@Stability(Stable)
public interface CfnTopicPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTopicPolicy.

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;
 CfnTopicPolicyProps cfnTopicPolicyProps = CfnTopicPolicyProps.builder()
         .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	Interface	Description
static final class	CfnTopicPolicyProps.Builder	A builder for CfnTopicPolicyProps
static final class	CfnTopicPolicyProps.Jsii$Proxy	An implementation for CfnTopicPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnTopicPolicyProps.Builder	builder()
Object	getPolicyDocument()	A policy document that contains permissions to add to the specified SNS topics.
List<String>	getTopics()	The Amazon Resource Names (ARN) of the topics to which you want to add the policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
Object getPolicyDocument()

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

See Also:

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

getTopics

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

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

You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html) resource.

See Also:

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

builder

@Stability(Stable)
static CfnTopicPolicyProps.Builder builder()

Returns:

a CfnTopicPolicyProps.Builder of CfnTopicPolicyProps