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	`awscc.sns.topics`

Fields

get (all properties)
list (identifiers only)

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.<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 />You can only add one policy per topic.<br />The policy must be in JSON string format.<br />Length Constraints: Maximum length of 30,720.
▶`subscription`	`array`	The SNS subscriptions (endpoints) for this topic.<br />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.<br />+ 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. <br />+ 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).<br />(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.
`fifo_throughput_scope`	`string`
▶`tags`	`array`	The list of tags to add to a new topic.<br />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``.<br />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).<br />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`	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:<br />+ HTTP <br />+ Amazon Kinesis Data Firehose<br />+ AWS Lambda<br />+ Platform application endpoint<br />+ Amazon Simple Queue Service<br /><br />Once configured, log entries are sent to Amazon CloudWatch Logs.
`region`	`string`	AWS region.

Name	Datatype	Description
`topic_arn`	`string`
`region`	`string`	AWS region.

For more information, see AWS::SNS::Topic.

Methods

Name	Resource	Accessible by	Required Params
`create_resource`	`topics`	`INSERT`	`region`
`delete_resource`	`topics`	`DELETE`	`Identifier, region`
`update_resource`	`topics`	`UPDATE`	`Identifier, PatchDocument, region`
`list_resources`	`topics_list_only`	`SELECT`	`region`
`get_resource`	`topics`	`SELECT`	`Identifier, region`

`SELECT` examples

get (all properties)
list (identifiers only)

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,
  fifo_throughput_scope,
  tags,
  topic_name,
  topic_arn,
  signature_version,
  tracing_config,
  delivery_status_logging
FROM awscc.sns.topics
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ topic_arn }}';

Lists all topics in a region.

SELECT
  region,
  topic_arn
FROM awscc.sns.topics_list_only
WHERE
  region = 'us-east-1';

`INSERT` example

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

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.sns.topics (
  DisplayName,
  KmsMasterKeyId,
  DataProtectionPolicy,
  Subscription,
  FifoTopic,
  ContentBasedDeduplication,
  ArchivePolicy,
  FifoThroughputScope,
  Tags,
  TopicName,
  SignatureVersion,
  TracingConfig,
  DeliveryStatusLogging,
  region
)
SELECT
  '{{ display_name }}',
  '{{ kms_master_key_id }}',
  '{{ data_protection_policy }}',
  '{{ subscription }}',
  '{{ fifo_topic }}',
  '{{ content_based_deduplication }}',
  '{{ archive_policy }}',
  '{{ fifo_throughput_scope }}',
  '{{ tags }}',
  '{{ topic_name }}',
  '{{ signature_version }}',
  '{{ tracing_config }}',
  '{{ delivery_status_logging }}',
  '{{ region }}';

/*+ create */
INSERT INTO awscc.sns.topics (
  DisplayName,
  KmsMasterKeyId,
  DataProtectionPolicy,
  Subscription,
  FifoTopic,
  ContentBasedDeduplication,
  ArchivePolicy,
  FifoThroughputScope,
  Tags,
  TopicName,
  SignatureVersion,
  TracingConfig,
  DeliveryStatusLogging,
  region
)
SELECT
  '{{ display_name }}',
  '{{ kms_master_key_id }}',
  '{{ data_protection_policy }}',
  '{{ subscription }}',
  '{{ fifo_topic }}',
  '{{ content_based_deduplication }}',
  '{{ archive_policy }}',
  '{{ fifo_throughput_scope }}',
  '{{ tags }}',
  '{{ topic_name }}',
  '{{ signature_version }}',
  '{{ tracing_config }}',
  '{{ delivery_status_logging }}',
  '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: topic
    props:
      - name: display_name
        value: '{{ display_name }}'
      - name: kms_master_key_id
        value: '{{ kms_master_key_id }}'
      - name: data_protection_policy
        value: {}
      - name: subscription
        value:
          - endpoint: '{{ endpoint }}'
            protocol: '{{ protocol }}'
      - name: fifo_topic
        value: '{{ fifo_topic }}'
      - name: content_based_deduplication
        value: '{{ content_based_deduplication }}'
      - name: archive_policy
        value: {}
      - name: fifo_throughput_scope
        value: '{{ fifo_throughput_scope }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: topic_name
        value: '{{ topic_name }}'
      - name: signature_version
        value: '{{ signature_version }}'
      - name: tracing_config
        value: '{{ tracing_config }}'
      - name: delivery_status_logging
        value:
          - protocol: '{{ protocol }}'
            success_feedback_role_arn: '{{ success_feedback_role_arn }}'
            success_feedback_sample_rate: '{{ success_feedback_sample_rate }}'
            failure_feedback_role_arn: '{{ failure_feedback_role_arn }}'

`UPDATE` example

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

/*+ update */
UPDATE awscc.sns.topics
SET PatchDocument = string('{{ {
    "DisplayName": display_name,
    "KmsMasterKeyId": kms_master_key_id,
    "DataProtectionPolicy": data_protection_policy,
    "Subscription": subscription,
    "ContentBasedDeduplication": content_based_deduplication,
    "ArchivePolicy": archive_policy,
    "FifoThroughputScope": fifo_throughput_scope,
    "Tags": tags,
    "SignatureVersion": signature_version,
    "TracingConfig": tracing_config,
    "DeliveryStatusLogging": delivery_status_logging
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ topic_arn }}';

`DELETE` example

/*+ delete */
DELETE FROM awscc.sns.topics
WHERE
  Identifier = '{{ topic_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create
Read
Update
Delete
List

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

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

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

sns:GetTopicAttributes,
sns:DeleteTopic

sns:ListTopics

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​

Permissions​