community.aws.sns_topic module – Manages AWS SNS topics and subscriptions
Note
This module is part of the community.aws collection (version 8.0.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.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
Whether to enable content-based deduplication for this topic. Ignored unless topic_type=fifo. Defaults to Choices:
|
|
Use a The Choices:
|
|
Delivery policy to apply to the SNS topic. |
|
Delivery policy for HTTP(S) messages. See https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html for more information. |
|
Retry policy for HTTP(S) messages. |
|
The function for backoff between retries. Choices:
|
|
The maximum delay for a retry. |
|
The minimum delay for a retry. |
|
The number of retries with the maximum delay between them. |
|
The number of retries with just the minimum delay between them. |
|
The number of retries to be performmed immediately. |
|
The total number of retries. |
|
Throttle the rate of messages sent to subsriptions. |
|
The maximum number of deliveries per second per subscription. |
|
Applies this policy to all subscriptions, even if they have their own policies. Choices:
|
|
Display name of the topic. |
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The name or ARN of the SNS topic to manage. |
|
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. |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
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:
|
|
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 Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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 |
|
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 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 |
|
Whether to create or destroy an SNS topic. Choices:
|
|
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 of subscription. Only supports RawMessageDelievery for SQS endpoints. Default: |
|
Endpoint of subscription. |
|
Protocol of subscription. |
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
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:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
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 |
---|---|
The ARN of the topic you are modifying Returned: always Sample: |
|
Dict of sns topic details Returned: always |
|
list of attributes set during this run Returned: always Sample: |
|
whether check mode was on Returned: always Sample: |
|
Whether or not content_based_deduplication was set Returned: always Sample: |
|
Delivery policy for the SNS topic Returned: when topic is owned by this AWS account Sample: |
|
Display name for SNS topic Returned: when topic is owned by this AWS account Sample: |
|
Topic name Returned: always Sample: |
|
AWS account that owns the topic Returned: when topic is owned by this AWS account Sample: |
|
Policy for the SNS topic Returned: when topic is owned by this AWS account Sample: |
|
whether the topic is present or absent Returned: always Sample: |
|
List of subscribers to the topic in this AWS account Returned: always Sample: |
|
List of subscribers added in this run Returned: always Sample: |
|
Count of confirmed subscriptions Returned: when topic is owned by this AWS account Sample: |
|
Count of deleted subscriptions Returned: when topic is owned by this AWS account Sample: |
|
List of existing subscriptions Returned: always Sample: |
|
List of new subscriptions Returned: always Sample: |
|
Count of pending subscriptions Returned: when topic is owned by this AWS account Sample: |
|
Whether or not purge_subscriptions was set Returned: always Sample: |
|
ARN of the SNS topic (equivalent to sns_arn) Returned: when topic is owned by this AWS account Sample: |
|
Whether the topic was created Returned: always Sample: |
|
Whether the topic was deleted Returned: always Sample: |