AWS::SNS::TopicInlinePolicy - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SNS::TopicInlinePolicy

The AWS::SNS::TopicInlinePolicy resource associates one Amazon SNS topic with one policy.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SNS::TopicInlinePolicy",
  "Properties" : {
      "PolicyDocument" : Json,
      "TopicArn" : String
    }
}

YAML

Type: AWS::SNS::TopicInlinePolicy
Properties:
  PolicyDocument: Json
  TopicArn: String

Properties

PolicyDocument

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

Required: Yes

Type: Json

Update requires: No interruption

TopicArn

The Amazon Resource Name (ARN) of the topic to which you want to add the policy.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the topic for which the policy was added.

For more information about using the Ref function, see Ref.