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.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.166Z")
@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");
 PolicyDocument policyDocument = PolicyDocument.Builder.create()
         .assignSids(true)
         .statements(List.of(
             PolicyStatement.Builder.create()
                     .actions(List.of("sns:Subscribe"))
                     .principals(List.of(new AnyPrincipal()))
                     .resources(List.of(topic.getTopicArn()))
                     .build()))
         .build();
 TopicPolicy topicPolicy = TopicPolicy.Builder.create(this, "Policy")
         .topics(List.of(topic))
         .policyDocument(policyDocument)
         .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 Boolean	getEnforceSSL()	Adds a statement to enforce encryption of data in transit when publishing to the topic.
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.

getEnforceSSL

@Stability(Stable)
@Nullable
default Boolean getEnforceSSL()

Adds a statement to enforce encryption of data in transit when publishing to the topic.

For more information, see https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.

Default: false

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