CfnTopic
- class aws_cdk.aws_sns.CfnTopic(scope, id, *, archive_policy=None, content_based_deduplication=None, data_protection_policy=None, delivery_status_logging=None, display_name=None, fifo_topic=None, kms_master_key_id=None, signature_version=None, subscription=None, tags=None, topic_name=None, tracing_config=None)
Bases:
CfnResource
The
AWS::SNS::Topic
resource creates a topic to which notifications can be published.One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see Amazon SNS endpoints and quotas in the AWS General Reference .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html
- CloudformationResource:
AWS::SNS::Topic
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_sns as sns # archive_policy: Any # data_protection_policy: Any cfn_topic = sns.CfnTopic(self, "MyCfnTopic", archive_policy=archive_policy, content_based_deduplication=False, data_protection_policy=data_protection_policy, delivery_status_logging=[sns.CfnTopic.LoggingConfigProperty( protocol="protocol", # the properties below are optional failure_feedback_role_arn="failureFeedbackRoleArn", success_feedback_role_arn="successFeedbackRoleArn", success_feedback_sample_rate="successFeedbackSampleRate" )], display_name="displayName", fifo_topic=False, kms_master_key_id="kmsMasterKeyId", signature_version="signatureVersion", subscription=[sns.CfnTopic.SubscriptionProperty( endpoint="endpoint", protocol="protocol" )], tags=[CfnTag( key="key", value="value" )], topic_name="topicName", tracing_config="tracingConfig" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).archive_policy (
Any
) – TheArchivePolicy
determines the number of days Amazon SNS retains messages in FIFO topics. You can set a retention period ranging from 1 to 365 days. This property is only applicable to FIFO topics; attempting to use it with standard topics will result in a creation failure.content_based_deduplication (
Union
[bool
,IResolvable
,None
]) –ContentBasedDeduplication
enables deduplication of messages based on their content for FIFO topics. By default, this property is set to false. If you create a FIFO topic withContentBasedDeduplication
set to false, you must provide aMessageDeduplicationId
for eachPublish
action. When set to true, Amazon SNS automatically generates aMessageDeduplicationId
using a SHA-256 hash of the message body (excluding message attributes). You can optionally override this generated value by specifying aMessageDeduplicationId
in thePublish
action. Note that this property only applies to FIFO topics; using it with standard topics will cause the creation to fail.data_protection_policy (
Any
) – The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720.delivery_status_logging (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,LoggingConfigProperty
,Dict
[str
,Any
]]],None
]) – TheDeliveryStatusLogging
configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:. - HTTP - Amazon Kinesis Data Firehose - AWS Lambda - Platform application endpoint - Amazon Simple Queue Service Once configured, log entries are sent to Amazon CloudWatch Logs.display_name (
Optional
[str
]) – The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.fifo_topic (
Union
[bool
,IResolvable
,None
]) – Set to true to create a FIFO topic.kms_master_key_id (
Optional
[str
]) – The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key terms . For more examples, see[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
in the AWS Key Management Service API Reference . This property applies only to server-side-encryption .signature_version (
Optional
[str
]) – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default,SignatureVersion
is set to1
.subscription (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SubscriptionProperty
,Dict
[str
,Any
]]],None
]) – The Amazon SNS subscriptions (endpoints) for this topic. .. epigraph:: If you specify theSubscription
property in theAWS::SNS::Topic
resource and it creates an associated subscription resource, the associated subscription is not deleted when theAWS::SNS::Topic
resource is deleted.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The list of tags to add to a new topic. .. epigraph:: To be able to tag a topic on creation, you must have thesns:CreateTopic
andsns:TagResource
permissions.topic_name (
Optional
[str
]) – The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with.fifo
. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name type . .. epigraph:: If you specify a name, you can’t perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.tracing_config (
Optional
[str
]) – Tracing mode of an Amazon SNS topic. By defaultTracingConfig
is set toPassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set toActive
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::SNS::Topic'
- archive_policy
The
ArchivePolicy
determines the number of days Amazon SNS retains messages in FIFO topics.
- attr_topic_arn
Returns the ARN of an Amazon SNS topic.
- CloudformationAttribute:
TopicArn
- attr_topic_name
Returns the name of an Amazon SNS topic.
- CloudformationAttribute:
TopicName
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- content_based_deduplication
ContentBasedDeduplication
enables deduplication of messages based on their content for FIFO topics.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- data_protection_policy
The body of the policy document you want to use for this topic.
- delivery_status_logging
.
- Type:
The
DeliveryStatusLogging
configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols
- display_name
The display name to use for an Amazon SNS topic with SMS subscriptions.
- fifo_topic
Set to true to create a FIFO topic.
- kms_master_key_id
The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- signature_version
The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- subscription
The Amazon SNS subscriptions (endpoints) for this topic.
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
The list of tags to add to a new topic.
- topic_name
The name of the topic you want to create.
- tracing_config
Tracing mode of an Amazon SNS topic.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
LoggingConfigProperty
- class CfnTopic.LoggingConfigProperty(*, protocol, failure_feedback_role_arn=None, success_feedback_role_arn=None, success_feedback_sample_rate=None)
Bases:
object
The
LoggingConfig
property type specifies theDelivery
status logging configuration for an`AWS::SNS::Topic
<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html>`_ .- Parameters:
protocol (
str
) – Indicates one of the supported protocols for the Amazon SNS topic. .. epigraph:: At least one of the other threeLoggingConfig
properties is recommend along withProtocol
.failure_feedback_role_arn (
Optional
[str
]) – The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch.success_feedback_role_arn (
Optional
[str
]) – The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch.success_feedback_sample_rate (
Optional
[str
]) – The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_sns as sns logging_config_property = sns.CfnTopic.LoggingConfigProperty( protocol="protocol", # the properties below are optional failure_feedback_role_arn="failureFeedbackRoleArn", success_feedback_role_arn="successFeedbackRoleArn", success_feedback_sample_rate="successFeedbackSampleRate" )
Attributes
- failure_feedback_role_arn
The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch.
- protocol
Indicates one of the supported protocols for the Amazon SNS topic.
At least one of the other three
LoggingConfig
properties is recommend along withProtocol
.
- success_feedback_role_arn
The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch.
- success_feedback_sample_rate
The percentage of successful message deliveries to be logged in Amazon CloudWatch.
Valid percentage values range from 0 to 100.
SubscriptionProperty
- class CfnTopic.SubscriptionProperty(*, endpoint, protocol)
Bases:
object
Subscription
is an embedded property that describes the subscription endpoints of an Amazon SNS topic.For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the AWS::SNS::Subscription resource.
- Parameters:
endpoint (
str
) – The endpoint that receives notifications from the Amazon SNS topic. The endpoint value depends on the protocol that you specify. For more information, see theEndpoint
parameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .protocol (
str
) – The subscription’s protocol. For more information, see theProtocol
parameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_sns as sns subscription_property = sns.CfnTopic.SubscriptionProperty( endpoint="endpoint", protocol="protocol" )
Attributes
- endpoint
The endpoint that receives notifications from the Amazon SNS topic.
The endpoint value depends on the protocol that you specify. For more information, see the
Endpoint
parameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .
- protocol
The subscription’s protocol.
For more information, see the
Protocol
parameter of the[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .