community.aws.sns_topic – Manages AWS SNS topics and subscriptions  Note This plugin is part of the community.aws collection (version 1.3.0). To install it use: ansible-galaxy collection install community.aws. To use it in a playbook, specify: community.aws.sns_topic.   New in version 1.0.0: of community.aws   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  The 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.  Requirements The below requirements are needed on the host that executes this module.  boto python >= 2.6  Parameters   Parameter Choices/Defaults Comments    aws_access_key  string      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: ec2_access_key, access_key     aws_ca_bundle  path      The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.     aws_config  dictionary      A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.     aws_secret_key  string      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: ec2_secret_key, secret_key     debug_botocore_endpoint_logs  boolean    
Choices: 
no ← yes    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.     delivery_policy  dictionary      Delivery policy to apply to the SNS topic.     display_name  string      Display name of the topic.     ec2_url  string      Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. 
aliases: aws_endpoint_url, endpoint_url     name  string / required      The name or ARN of the SNS topic to manage.     policy  dictionary      Policy to apply to the SNS topic.     profile  string      Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. 
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. 
aliases: aws_profile     purge_subscriptions  boolean    
Choices: no 
yes ←    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.     region  string      The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
 
aliases: aws_region, ec2_region     security_token  string      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: aws_security_token, access_token     state  string    
Choices: absent 
present ←    Whether to create or destroy an SNS topic.     subscriptions  list / elements=dictionary    Default:[]   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.      endpoint  string / required      Endpoint of subscription.      protocol  string / required      Protocol of subscription.     validate_certs  boolean    
Choices: no 
yes ←    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.     Notes  Note  If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
 Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
 
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file   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: 3
            numMaxDelayRetries: 5
            backoffFunction: "<linear|arithmetic|geometric|exponential>"
        disableSubscriptionOverrides: True
        defaultThrottlePolicy:
            maxReceivesPerSecond: 10
    subscriptions:
      - endpoint: "nicole88@example.net"
        protocol: "email"
      - endpoint: "my_mobile_number"
        protocol: "sms"
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    community.aws.sns_topic  complex   always  Dict of sns topic details        attributes_set  list / elements=string   always  list of attributes set during this run        check_mode  boolean   always  whether check mode was on        delivery_policy  string   when topic is owned by this AWS account  Delivery policy for the SNS topic  Sample: {"http":{"defaultHealthyRetryPolicy":{"minDelayTarget":20,"maxDelayTarget":20,"numRetries":3,"numMaxDelayRetries":0, "numNoDelayRetries":0,"numMinDelayRetries":0,"backoffFunction":"linear"},"disableSubscriptionOverrides":false}}       display_name  string   when topic is owned by this AWS account  Display name for SNS topic  Sample: My topic name       name  string   always  Topic name  Sample: ansible-test-dummy-topic       owner  string   when topic is owned by this AWS account  AWS account that owns the topic  Sample: 111111111111       policy  string   when topic is owned by this AWS account  Policy for the SNS topic  Sample: {"Version":"2012-10-17","Id":"SomePolicyId","Statement":[{"Sid":"ANewSid","Effect":"Allow","Principal":{"AWS":"arn:aws:iam8b7c:f320:99b9:690f:4595:cd17:293a:c06911111111:root"}, "Action":"sns:Subscribe","Resource":"arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic","Condition":{"StringEquals":{"sns:Protocol":"email"}}}]}       state  string   always  whether the topic is present or absent  Sample: present       subscriptions  list / elements=string   always  List of subscribers to the topic in this AWS account        subscriptions_added  list / elements=string   always  List of subscribers added in this run        subscriptions_confirmed  string   when topic is owned by this AWS account  Count of confirmed subscriptions  Sample: 0       subscriptions_deleted  string   when topic is owned by this AWS account  Count of deleted subscriptions  Sample: 0       subscriptions_existing  list / elements=string   always  List of existing subscriptions        subscriptions_new  list / elements=string   always  List of new subscriptions        subscriptions_pending  string   when topic is owned by this AWS account  Count of pending subscriptions  Sample: 0       subscriptions_purge  boolean   always  Whether or not purge_subscriptions was set  Sample: True       topic_arn  string   when topic is owned by this AWS account  ARN of the SNS topic (equivalent to sns_arn)  Sample: arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic       topic_created  boolean   always  Whether the topic was created        topic_deleted  boolean   always  Whether the topic was deleted      sns_arn  string   always  The ARN of the topic you are modifying  Sample: arn:aws:sns:us-east-2:111111111111:my_topic_name     Authors  Joel Thompson (@joelthompson) Fernando Jose Pando (@nand0p) Will Thames (@willthames) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.10/collections/community/aws/sns_topic_module.html', 'source': 'DevDocs.IO'}