Package software.amazon.awscdk.services.sns

Class CfnTopicPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sns.CfnTopicPolicy
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.164Z") @Stability(Stable) public class CfnTopicPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::SNS::TopicPolicy.

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy. For an example snippet, see Declaring an Amazon SNS policy in the AWS 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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

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

      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.

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

      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.