software.amazon.awscdk.services.sns

Interface TopicPolicyProps

All Known Implementing Classes:

TopicPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.112Z")
public interface TopicPolicyProps

Properties to associate SNS topics with a policy.

Example:

 Topic topic = new Topic(this, "Topic");
 TopicPolicy topicPolicy = TopicPolicy.Builder.create(this, "TopicPolicy")
         .topics(List.of(topic))
         .build();
 topicPolicy.document.addStatements(PolicyStatement.Builder.create()
         .actions(List.of("sns:Subscribe"))
         .principals(List.of(new AnyPrincipal()))
         .resources(List.of(topic.getTopicArn()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TopicPolicyProps.Builder A builder for TopicPolicyProps
static class	TopicPolicyProps.Jsii$Proxy An implementation for TopicPolicyProps

Method Summary

Modifier and Type	Method and Description
static TopicPolicyProps.Builder	builder()
default PolicyDocument	getPolicyDocument() IAM policy document to apply to topic(s).
java.util.List<ITopic>	getTopics() The set of topics this policy applies to.

Method Detail

getTopics

java.util.List<ITopic> getTopics()

The set of topics this policy applies to.

getPolicyDocument

default PolicyDocument getPolicyDocument()

IAM policy document to apply to topic(s).

Default: empty policy document

builder

static TopicPolicyProps.Builder builder()

Returns:

a TopicPolicyProps.Builder of TopicPolicyProps