community / community.aws / 1.1.0 / module / sns_topic Manages AWS SNS topics and subscriptions | "added in version" 1.0.0 of community.aws" Authors: Joel Thompson (@joelthompson), Fernando Jose Pando (@nand0p), Will Thames (@willthames)community.aws.sns_topic (1.1.0) — module
Install with ansible-galaxy collection install community.aws:==1.1.0
collections: - name: community.aws version: 1.1.0
The M(community.aws.sns_topic) module allows you to create, delete, and manage subscriptions for AWS SNS topics.
As of 2.6, this module can be use to subscribe and unsubscribe to topics outside of your AWS account.
- 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: 3 numMaxDelayRetries: 5 backoffFunction: "<linear|arithmetic|geometric|exponential>" disableSubscriptionOverrides: True defaultThrottlePolicy: maxReceivesPerSecond: 10 subscriptions: - endpoint: "my_email_address@example.com" protocol: "email" - endpoint: "my_mobile_number" protocol: "sms"
name: description: - The name or ARN of the SNS topic to manage. required: true type: str state: choices: - absent - present default: present description: - Whether to create or destroy an SNS topic. type: str policy: description: - Policy to apply to the SNS topic. type: dict region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str display_name: description: - Display name of the topic. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str subscriptions: default: [] description: - 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. elements: dict suboptions: endpoint: description: Endpoint of subscription. required: true protocol: description: Protocol of subscription. required: true type: list validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool delivery_policy: description: - Delivery policy to apply to the SNS topic. type: dict purge_subscriptions: default: true description: - '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.' type: bool debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
community.aws.sns_topic: contains: attributes_set: description: list of attributes set during this run returned: always sample: [] type: list check_mode: description: whether check mode was on returned: always sample: false type: bool delivery_policy: description: 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}} ' type: str display_name: description: Display name for SNS topic returned: when topic is owned by this AWS account sample: My topic name type: str name: description: Topic name returned: always sample: ansible-test-dummy-topic type: str owner: description: AWS account that owns the topic returned: when topic is owned by this AWS account sample: '111111111111' type: str policy: description: 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::111111111111:root"}, "Action":"sns:Subscribe","Resource":"arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic","Condition":{"StringEquals":{"sns:Protocol":"email"}}}]} ' type: str state: description: whether the topic is present or absent returned: always sample: present type: str subscriptions: description: List of subscribers to the topic in this AWS account returned: always sample: [] type: list subscriptions_added: description: List of subscribers added in this run returned: always sample: [] type: list subscriptions_confirmed: description: Count of confirmed subscriptions returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_deleted: description: Count of deleted subscriptions returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_existing: description: List of existing subscriptions returned: always sample: [] type: list subscriptions_new: description: List of new subscriptions returned: always sample: [] type: list subscriptions_pending: description: Count of pending subscriptions returned: when topic is owned by this AWS account sample: '0' type: str subscriptions_purge: description: Whether or not purge_subscriptions was set returned: always sample: true type: bool topic_arn: description: 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:111111111111:ansible-test-dummy-topic type: str topic_created: description: Whether the topic was created returned: always sample: false type: bool topic_deleted: description: Whether the topic was deleted returned: always sample: false type: bool description: Dict of sns topic details returned: always type: complex sns_arn: description: The ARN of the topic you are modifying returned: always sample: arn:aws:sns:us-east-2:111111111111:my_topic_name type: str