topics

Creates, updates, deletes or gets a topic resource or lists topics in a region

Overview

Name	topics
Type	Resource
Description	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 [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*. The structure of AUTHPARAMS depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
Id	aws.sns.topics

Fields

Name	Datatype	Description
display_name	string	The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
kms_master_key_id	string	The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see KeyId in the *API Reference*. 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. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720.
subscription	array	The SNS subscriptions (endpoints) for this topic. If you specify the Subscription property in the AWS::SNS::Topic resource and it creates an associated subscription resource, the associated subscription is not deleted when the AWS::SNS::Topic resource is deleted.
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](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ContentBasedDeduplication to true, SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
archive_policy	object	The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
tags	array	The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
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. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). 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.
topic_arn	string
signature_version	string	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 to 1.
tracing_config	string	Tracing mode of an 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.
delivery_status_logging	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all topics in a region.

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 aws.sns.topics
WHERE region = 'us-east-1';

Gets all properties from an individual topic.

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 aws.sns.topics
WHERE region = 'us-east-1' AND data__Identifier = '<TopicArn>';

INSERT example

Use the following StackQL query and manifest file to create a new topic resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sns.topics (
 DisplayName,
 KmsMasterKeyId,
 DataProtectionPolicy,
 Subscription,
 FifoTopic,
 ContentBasedDeduplication,
 ArchivePolicy,
 Tags,
 TopicName,
 SignatureVersion,
 TracingConfig,
 DeliveryStatusLogging,
 region
)
SELECT 
'{{ DisplayName }}',
 '{{ KmsMasterKeyId }}',
 '{{ DataProtectionPolicy }}',
 '{{ Subscription }}',
 '{{ FifoTopic }}',
 '{{ ContentBasedDeduplication }}',
 '{{ ArchivePolicy }}',
 '{{ Tags }}',
 '{{ TopicName }}',
 '{{ SignatureVersion }}',
 '{{ TracingConfig }}',
 '{{ DeliveryStatusLogging }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sns.topics (
 DisplayName,
 KmsMasterKeyId,
 DataProtectionPolicy,
 Subscription,
 FifoTopic,
 ContentBasedDeduplication,
 ArchivePolicy,
 Tags,
 TopicName,
 SignatureVersion,
 TracingConfig,
 DeliveryStatusLogging,
 region
)
SELECT 
 '{{ DisplayName }}',
 '{{ KmsMasterKeyId }}',
 '{{ DataProtectionPolicy }}',
 '{{ Subscription }}',
 '{{ FifoTopic }}',
 '{{ ContentBasedDeduplication }}',
 '{{ ArchivePolicy }}',
 '{{ Tags }}',
 '{{ TopicName }}',
 '{{ SignatureVersion }}',
 '{{ TracingConfig }}',
 '{{ DeliveryStatusLogging }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: topic
    props:
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: KmsMasterKeyId
        value: '{{ KmsMasterKeyId }}'
      - name: DataProtectionPolicy
        value: {}
      - name: Subscription
        value:
          - Endpoint: '{{ Endpoint }}'
            Protocol: '{{ Protocol }}'
      - name: FifoTopic
        value: '{{ FifoTopic }}'
      - name: ContentBasedDeduplication
        value: '{{ ContentBasedDeduplication }}'
      - name: ArchivePolicy
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TopicName
        value: '{{ TopicName }}'
      - name: SignatureVersion
        value: '{{ SignatureVersion }}'
      - name: TracingConfig
        value: '{{ TracingConfig }}'
      - name: DeliveryStatusLogging
        value:
          - Protocol: '{{ Protocol }}'
            SuccessFeedbackRoleArn: '{{ SuccessFeedbackRoleArn }}'
            SuccessFeedbackSampleRate: '{{ SuccessFeedbackSampleRate }}'
            FailureFeedbackRoleArn: '{{ FailureFeedbackRoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.sns.topics
WHERE data__Identifier = '<TopicArn>'
AND region = 'us-east-1';

Permissions

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

Create

sns:CreateTopic,
sns:TagResource,
sns:Subscribe,
sns:GetTopicAttributes,
sns:PutDataProtectionPolicy,
iam:GetRole,
iam:PassRole

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

List

sns:ListTopics