topic

Gets an individual topic resource

Overview

Name	topic
Type	Resource
Description	topic
Id	awscc.sns.topic

Fields

Name	Datatype	Description
display_name	string	The display name to use for an Amazon SNS topic with SMS subscriptions.
kms_master_key_id	string	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 in the AWS Key Management Service API Reference.<br/><br/>This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
data_protection_policy	object	The body of the policy document you want to use for this topic.<br/><br/>You can only add one policy per topic.<br/><br/>The policy must be in JSON string format.<br/><br/>Length Constraints: Maximum length of 30720
subscription	array	The SNS subscriptions (endpoints) for this topic.
fifo_topic	boolean	Set to true to create a FIFO topic.
content_based_deduplication	boolean	Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.<br/><br/>When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).<br/><br/>(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.<br/><br/>
archive_policy	object	The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days.
tags	array
topic_name	string	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.<br/><br/>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.
topic_arn	string
signature_version	string	Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.
tracing_config	string	Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.
delivery_status_logging	array	Delivery status logging configuration for supported protocols for an Amazon SNS topic.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
display_name,
kms_master_key_id,
data_protection_policy,
subscription,
fifo_topic,
content_based_deduplication,
archive_policy,
tags,
topic_name,
topic_arn,
signature_version,
tracing_config,
delivery_status_logging
FROM awscc.sns.topic
WHERE data__Identifier = '<TopicArn>';

Permissions

To operate on the topic resource, the following permissions are required:

Read

sns:GetTopicAttributes,
sns:ListTagsForResource,
sns:ListSubscriptionsByTopic,
sns:GetDataProtectionPolicy

Update

sns:SetTopicAttributes,
sns:TagResource,
sns:UntagResource,
sns:Subscribe,
sns:Unsubscribe,
sns:GetTopicAttributes,
sns:ListTagsForResource,
sns:ListSubscriptionsByTopic,
sns:GetDataProtectionPolicy,
sns:PutDataProtectionPolicy,
iam:GetRole,
iam:PassRole

Delete

sns:GetTopicAttributes,
sns:DeleteTopic