class TopicPolicy (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SNS.TopicPolicy`
Java	`software.amazon.awscdk.services.sns.TopicPolicy`
Python	`aws_cdk.aws_sns.TopicPolicy`
TypeScript (source)	`@aws-cdk/aws-sns` » `TopicPolicy`

Implements IConstruct, IConstruct, IDependable, IResource

The policy for an SNS Topic.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

Example

const topic = new sns.Topic(this, 'Topic');
const topicPolicy = new sns.TopicPolicy(this, 'TopicPolicy', {
  topics: [topic],
});

topicPolicy.document.addStatements(new iam.PolicyStatement({
  actions: ["sns:Subscribe"],
  principals: [new iam.AnyPrincipal()],
  resources: [topic.topicArn],
}));

Initializer

new TopicPolicy(scope: Construct, id: string, props: TopicPolicyProps)

Parameters

scope Construct
id string
props TopicPolicyProps

Construct Props

Name	Type	Description
topics	`ITopic[]`	The set of topics this policy applies to.
policyDocument?	`PolicyDocument`	IAM policy document to apply to topic(s).

topics

Type: ITopic[]

The set of topics this policy applies to.

policyDocument?

Type: PolicyDocument (optional, default: empty policy document)

IAM policy document to apply to topic(s).

Properties

Name	Type	Description
document	`PolicyDocument`	The IAM policy document for this policy.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`ConstructNode`	The construct tree node associated with this construct.
stack	`Stack`	The stack in which this resource is defined.

document

Type: PolicyDocument

The IAM policy document for this policy.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: ConstructNode

The construct tree node associated with this construct.

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.