Class CfnTopicPolicy

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnTopicPolicy
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SNS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTopicPolicy : CfnResource, IInspectable
Syntax (vb)
Public Class CfnTopicPolicy Inherits CfnResource Implements IInspectable
Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SNS;

             var policyDocument;

             var cfnTopicPolicy = new CfnTopicPolicy(this, "MyCfnTopicPolicy", new CfnTopicPolicyProps {
                 PolicyDocument = policyDocument,
                 Topics = new [] { "topics" }
             });

Synopsis

Constructors

CfnTopicPolicy(Construct, string, ICfnTopicPolicyProps)

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

Properties

AttrId

The provider-assigned unique ID for this managed resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.
PolicyDocument

A policy document that contains permissions to add to the specified SNS topics.
Topics

The Amazon Resource Names (ARN) of the topics to which you want to add the policy.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

Constructors

CfnTopicPolicy(Construct, string, ICfnTopicPolicyProps)

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

public CfnTopicPolicy(Construct scope, string id, ICfnTopicPolicyProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnTopicPolicyProps

Resource properties.

Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

Properties

AttrId

The provider-assigned unique ID for this managed resource.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

PolicyDocument

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

public virtual object PolicyDocument { get; set; }
Property Value

object

Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

Topics

The Amazon Resource Names (ARN) of the topics to which you want to add the policy.

public virtual string[] Topics { get; set; }
Property Value

string[]

Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::SNS::TopicPolicy resource associates Amazon SNS topics with a policy.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

For an example snippet, see Declaring an Amazon SNS policy in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topicpolicy.html

CloudformationResource: AWS::SNS::TopicPolicy

ExampleMetadata: fixture=_generated

Implements