You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.aws.sns_topic module – Manages AWS SNS topics and subscriptions

Note

This module is part of the community.aws collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.sns_topic.

New in community.aws 1.0.0

Synopsis

• The community.aws.sns_topic module allows you to create, delete, and manage subscriptions for AWS SNS topics.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.6

• boto3 >= 1.18.0

• botocore >= 1.21.0

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 access_key will always fall back to the environment variables if set. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The AWS_CA_BUNDLE environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
content_based_deduplication string added in community.aws 5.3.0	Whether to enable content-based deduplication for this topic. Ignored unless topic_type=fifo. Defaults to disabled. Choices: "disabled" "enabled"
debug_botocore_endpoint_logs boolean	Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices: false ← (default) true
delivery_policy dictionary	Delivery policy to apply to the SNS topic.
http dictionary	Delivery policy for HTTP(S) messages. See https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html for more information.
defaultHealthyRetryPolicy dictionary / required	Retry policy for HTTP(S) messages.
backoffFunction string / required	The function for backoff between retries. Choices: "arithmetic" "exponential" "geometric" "linear"
maxDelayTarget integer / required	The maximum delay for a retry.
minDelayTarget integer / required	The minimum delay for a retry.
numMaxDelayRetries integer / required	The number of retries with the maximum delay between them.
numMinDelayRetries integer / required	The number of retries with just the minimum delay between them.
numNoDelayRetries integer / required	The number of retries to be performmed immediately.
numRetries integer / required	The total number of retries.
defaultThrottlePolicy dictionary	Throttle the rate of messages sent to subsriptions.
maxReceivesPerSecond integer / required	The maximum number of deliveries per second per subscription.
disableSubscriptionOverrides boolean	Applies this policy to all subscriptions, even if they have their own policies. Choices: false true
display_name string	Display name of the topic.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.
name string / required	The name or ARN of the SNS topic to manage.
policy dictionary	Policy to apply to the SNS topic. Policy body can be YAML or JSON. This is required for certain use cases for example with S3 bucket notifications.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The AWS_PROFILE environment variable may also be used. Prior to release 6.0.0 the AWS_PROFILE environment variable will be ignored if any of access_key, secret_key, or session_token are passed. After release 6.0.0 profile will always fall back to the AWS_PROFILE environment variable if set. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
purge_subscriptions boolean	Whether to purge any subscriptions not listed here. NOTE: AWS does not allow you to purge any PendingConfirmation subscriptions, so if any exist and would be purged, they are silently skipped. This means that somebody could come back later and confirm the subscription. Sorry. Blame Amazon. Choices: false true ← (default)
purge_tags boolean	If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Choices: false true ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The AWS_REGION or EC2_REGION environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01 Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 secret_key will always fall back to the environment variables if set. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. Prior to release 6.0.0 these environment variables will be ignored if the profile parameter is passed. After release 6.0.0 session_token will always fall back to the environment variables if set. The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string	Whether to create or destroy an SNS topic. Choices: "absent" "present" ← (default)
subscriptions list / elements=dictionary	List of subscriptions to apply to the topic. Note that AWS requires subscriptions to be confirmed, so you will need to confirm any new subscriptions. Default: []
attributes string added in community.aws 4.1.0	Attributes of subscription. Only supports RawMessageDelievery for SQS endpoints. Default: {}
endpoint string / required	Endpoint of subscription.
protocol string / required	Protocol of subscription.
tags aliases: resource_tags dictionary	A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified.
topic_type string added in community.aws 2.0.0	The type of topic that should be created. Either Standard for FIFO (first-in, first-out). Some regions, including GovCloud regions do not support FIFO topics. Use a default value of ‘standard’ or omit the option if the region does not support FIFO topics. Choices: "standard" ← (default) "fifo"
validate_certs boolean	When set to false, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: false true ← (default)

Notes

Note

• Support for tags and purge_tags was added in release 5.3.0.

• Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

• The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: Create alarm SNS topic
  community.aws.sns_topic:
    name: "alarms"
    state: present
    display_name: "alarm SNS topic"
    delivery_policy:
      http:
        defaultHealthyRetryPolicy:
          minDelayTarget: 2
          maxDelayTarget: 4
          numRetries: 9
          numMaxDelayRetries: 5
          numMinDelayRetries: 2
          numNoDelayRetries: 2
          backoffFunction: "linear"
        disableSubscriptionOverrides: True
        defaultThrottlePolicy:
          maxReceivesPerSecond: 10
    subscriptions:
      - endpoint: "[email protected]"
        protocol: "email"
      - endpoint: "my_mobile_number"
        protocol: "sms"

- name: Create a topic permitting S3 bucket notifications
  community.aws.sns_topic:
    name: "S3Notifications"
    state: present
    display_name: "S3 notifications SNS topic"
    policy:
      Id: s3-topic-policy
      Version: 2012-10-17
      Statement:
        - Sid: Statement-id
          Effect: Allow
          Resource: "arn:aws:sns:*:*:S3Notifications"
          Principal:
            Service: s3.amazonaws.com
          Action: sns:Publish
          Condition:
            ArnLike:
              aws:SourceArn: "arn:aws:s3:*:*:SomeBucket"

- name: Example deleting a topic
  community.aws.sns_topic:
    name: "ExampleTopic"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
sns_arn string	The ARN of the topic you are modifying Returned: always Sample: "arn:aws:sns:us-east-2:123456789012:my_topic_name"
sns_topic complex	Dict of sns topic details Returned: always
attributes_set list / elements=string	list of attributes set during this run Returned: always Sample: []
check_mode boolean	whether check mode was on Returned: always Sample: false
content_based_deduplication string added in community.aws 5.3.0	Whether or not content_based_deduplication was set Returned: always Sample: "disabled"
delivery_policy string	Delivery policy for the SNS topic Returned: when topic is owned by this AWS account Sample: "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0, \"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}\n"
display_name string	Display name for SNS topic Returned: when topic is owned by this AWS account Sample: "My topic name"
name string	Topic name Returned: always Sample: "ansible-test-dummy-topic"
owner string	AWS account that owns the topic Returned: when topic is owned by this AWS account Sample: "123456789012"
policy string	Policy for the SNS topic Returned: when topic is owned by this AWS account Sample: "{\"Version\":\"2012-10-17\",\"Id\":\"SomePolicyId\",\"Statement\":[{\"Sid\":\"ANewSid\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sns:Subscribe\",\"Resource\":\"arn:aws:sns:us-east-2:123456789012:ansible-test-dummy-topic\",\"Condition\":{\"StringEquals\":{\"sns:Protocol\":\"email\"}}}]}\n"
state string	whether the topic is present or absent Returned: always Sample: "present"
subscriptions list / elements=string	List of subscribers to the topic in this AWS account Returned: always Sample: []
subscriptions_added list / elements=string	List of subscribers added in this run Returned: always Sample: []
subscriptions_confirmed string	Count of confirmed subscriptions Returned: when topic is owned by this AWS account Sample: "0"
subscriptions_deleted string	Count of deleted subscriptions Returned: when topic is owned by this AWS account Sample: "0"
subscriptions_existing list / elements=string	List of existing subscriptions Returned: always Sample: []
subscriptions_new list / elements=string	List of new subscriptions Returned: always Sample: []
subscriptions_pending string	Count of pending subscriptions Returned: when topic is owned by this AWS account Sample: "0"
subscriptions_purge boolean	Whether or not purge_subscriptions was set Returned: always Sample: true
topic_arn string	ARN of the SNS topic (equivalent to sns_arn) Returned: when topic is owned by this AWS account Sample: "arn:aws:sns:us-east-2:123456789012:ansible-test-dummy-topic"
topic_created boolean	Whether the topic was created Returned: always Sample: false
topic_deleted boolean	Whether the topic was deleted Returned: always Sample: false

Authors

• Joel Thompson (@joelthompson)

• Fernando Jose Pando (@nand0p)

• Will Thames (@willthames)

Collection links

Issue Tracker Repository (Sources) Communication