Protected ReadonlyautoControls automatic creation of policy objects.
Set by subclasses.
ReadonlycontentProtected OptionalenforceAdds a statement to enforce encryption of data in transit when publishing to the topic.
ReadonlyenvThe 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.
ReadonlyfifoOptional ReadonlymasterReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlystackThe stack in which this resource is defined.
ReadonlytopicReadonlytopicStatic ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Adds a delivery status logging configuration to the topic.
ProtectedaddAdds a SSL policy to the topic resource policy.
Subscribe some endpoint to this topic
Adds a statement to the IAM resource policy associated with this topic.
If this topic was created in this stack (new Topic), a topic policy
will be automatically created upon the first call to addToResourcePolicy.
However, if enforceSSL is set to true, the policy has already been created
before the first call to this method.
If the topic is imported (Topic.import), then this is a no-op.
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).
Represents a notification target That allows SNS topic to associate with this rule target.
ProtectedcreateAdds 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.
ProtectedcreateCreates a topic policy for this topic.
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grant topic publishing permissions to the given identity
Grant topic subscribing permissions to the given identity
Return the given named metric for this Topic
Optionalprops: MetricOptionsThe number of messages published to your Amazon SNS topics.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages that Amazon SNS failed to deliver.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages that were rejected by subscription filter policies.
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages that were rejected by subscription filter policies because the messages' attributes are invalid
Sum over 5 minutes
Optionalprops: MetricOptionsThe number of messages that were rejected by subscription filter policies because the messages have no attributes.
Sum over 5 minutes
Optionalprops: MetricOptionsMetric for the size of messages published through this topic
Average over 5 minutes
Optionalprops: MetricOptionsThe charges you have accrued since the start of the current calendar month for sending SMS messages.
Maximum over 5 minutes
Optionalprops: MetricOptionsThe rate of successful SMS message deliveries.
Sum over 5 minutes
Optionalprops: MetricOptionsReturns a string representation of this construct.
StaticfromImport an existing SNS topic provided an ARN
The parent creating construct
The construct's name
topic ARN (i.e. arn:aws:sns:us-east-2:444455556666:MyTopic)
StaticfromImport an existing SNS topic provided a topic attributes
The parent creating construct
The construct's name
the attributes of the topic to import
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
A construct which creates a compliant SNS Topic.