Skip to main content

Component: sns-topic

This component is responsible for provisioning an SNS topic.


Stack Level: Regional

Here are some example snippets for how to use this component:

stacks/catalog/sns-topic/defaults.yaml file (base component for all SNS topics with default settings):

type: abstract
workspace_enabled: true
enabled: true
Team: sre
Service: sns-topic
subscribers: {}
allowed_aws_services_for_sns_published: []
kms_master_key_id: alias/aws/sns
encryption_enabled: true
sqs_queue_kms_master_key_id: alias/aws/sqs
sqs_queue_kms_data_key_reuse_period_seconds: 300
allowed_iam_arns_for_sns_publish: []
sns_topic_policy_json: ""
sqs_dlq_enabled: false
sqs_dlq_max_message_size: 262144
sqs_dlq_message_retention_seconds: 1209600
delivery_policy: null
fifo_topic: false
fifo_queue_enabled: false
content_based_deduplication: false
redrive_policy_max_receiver_count: 5
redrive_policy: null
- catalog/sns-topic/defaults

component: sns-topic
- sns-topic/defaults
enabled: true
name: sns-topic-example
sqs_dlq_enabled: false
protocol: "https"
endpoint: ""
endpoint_auto_confirms: true


terraform>= 1.0.0
aws~> 4.0


No providers.




No resources.


additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
allowed_aws_services_for_sns_publishedAWS services that will have permission to publish to SNS topic. Used when no external JSON policy is usedlist(string)[]no
allowed_iam_arns_for_sns_publishIAM role/user ARNs that will have permission to publish to SNS topic. Used when no external json policy is used.list(string)[]no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
content_based_deduplicationEnable content-based deduplication for FIFO topicsboolfalseno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
delivery_policyThe SNS delivery policy as JSON.stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
enabledSet to false to prevent the module from creating any resourcesboolnullno
encryption_enabledWhether or not to use encryption for SNS Topic. If set to true and no custom value for KMS key (kms_master_key_id) is provided, it uses the default alias/aws/sns KMS key.booltrueno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
fifo_queue_enabledWhether or not to create a FIFO (first-in-first-out) queueboolfalseno
fifo_topicWhether or not to create a FIFO (first-in-first-out) topicboolfalseno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
import_profile_nameAWS Profile name to use when importing a resourcestringnullno
import_role_arnIAM Role ARN to use when importing a resourcestringnullno
kms_master_key_idThe ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.string"alias/aws/sns"no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
redrive_policyThe SNS redrive policy as JSON. This overrides var.redrive_policy_max_receiver_count and the deadLetterTargetArn (supplied by var.fifo_queue = true) passed in by the module.stringnullno
redrive_policy_max_receiver_countThe number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.number5no
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
sns_topic_policy_jsonThe fully-formed AWS policy as JSONstring""no
sqs_dlq_enabledEnable delivery of failed notifications to SQS and monitor messages in queue.boolfalseno
sqs_dlq_max_message_sizeThe limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).number262144no
sqs_dlq_message_retention_secondsThe number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days).number1209600no
sqs_queue_kms_data_key_reuse_period_secondsThe length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS againnumber300no
sqs_queue_kms_master_key_idThe ID of an AWS-managed customer master key (CMK) for Amazon SQS Queue or a custom CMKstring"alias/aws/sqs"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
subscribersRequired configuration for subscibres to SNS topic.
protocol = string
# The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below).
endpoint = string
# The endpoint to send data to, the contents will vary with the protocol. (see below for more information)
endpoint_auto_confirms = bool
# Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false)
raw_message_delivery = bool
# Boolean indicating whether or not to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property) (default is false)
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


dead_letter_queue_arnThe ARN of the dead letter queue.
dead_letter_queue_idThe ID for the created dead letter queue. Same as the URL.
dead_letter_queue_nameThe name for the created dead letter queue.
dead_letter_queue_urlThe URL for the created dead letter SQS queue.
sns_topic_arnSNS topic ARN.
sns_topic_idSNS topic ID.
sns_topic_nameSNS topic name.
sns_topic_ownerSNS topic owner.
sns_topic_subscriptionsSNS topic subscription.