Package software.amazon.awscdk.services.sns

Interface TopicPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TopicPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.202Z")
@Stability(Stable)
public interface TopicPolicyProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	TopicPolicyProps.Builder	A builder for TopicPolicyProps
static final class	TopicPolicyProps.Jsii$Proxy	An implementation for TopicPolicyProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTopics

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

The set of topics this policy applies to.

getPolicyDocument

@Stability(Stable)
@Nullable
default PolicyDocument getPolicyDocument()

IAM policy document to apply to topic(s).

Default: empty policy document

builder

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

Returns:

a TopicPolicyProps.Builder of TopicPolicyProps