community.aws.sqs_queue – Creates or deletes AWS SQS queues
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.sqs_queue.
New in version 1.0.0: of community.aws
Synopsis
- Create or delete AWS SQS queues.
- Update attributes on existing queues.
Requirements
The below requirements are needed on the host that executes this module.
- boto
- boto3
- 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 | |
| content_based_deduplication  boolean  | 
 | Enables content-based deduplication. Used for FIFOs only. Defaults to  false. | 
| 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. | 
| delay_seconds  integer  | The delivery delay in seconds. aliases: delivery_delay | |
| 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 | |
| kms_data_key_reuse_period_seconds  integer  | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. aliases: kms_data_key_reuse_period | |
| kms_master_key_id  string  | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | |
| maximum_message_size  integer  | The maximum message size in bytes. | |
| message_retention_period  integer  | The message retention period in seconds. | |
| name  string / required  | Name of the queue. | |
| policy  dictionary  | The JSON dict policy to attach to queue. | |
| 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_tags  boolean  | 
 | Remove tags not listed in tags. | 
| queue_type  string  | 
 | Standard or FIFO queue. 
queue_type can only be set at queue creation and will otherwise be ignored. | 
| receive_message_wait_time_seconds  integer  | The receive message wait time in seconds. aliases: receive_message_wait_time | |
| redrive_policy  dictionary  | JSON dict with the redrive_policy (see example). | |
| 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  | 
 | Create or delete the queue. | 
| tags  dictionary  | Tag dict to apply to the queue (requires botocore 1.5.40 or above). To remove all tags set tags={} and purge_tags=true. | |
| validate_certs  boolean  | 
 | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. | 
| visibility_timeout  integer  | The default visibility timeout in seconds. aliases: default_visibility_timeout | 
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_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_REGIONorEC2_REGIONcan 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 SQS queue with redrive policy
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    default_visibility_timeout: 120
    message_retention_period: 86400
    maximum_message_size: 1024
    delivery_delay: 30
    receive_message_wait_time: 20
    policy: "{{ json_dict }}"
    redrive_policy:
      maxReceiveCount: 5
      deadLetterTargetArn: arn:aws:sqs:eu-west-1:123456789012:my-dead-queue
- name: Drop redrive policy
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    redrive_policy: {}
- name: Create FIFO queue
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    queue_type: fifo
    content_based_deduplication: yes
- name: Tag queue
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    tags:
      example: SomeValue
- name: Configure Encryption, automatically uses a new data key every hour
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    kms_master_key_id: alias/MyQueueKey
    kms_data_key_reuse_period_seconds: 3600
- name: Delete SQS queue
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    state: absent
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| content_based_deduplication  boolean  | always | Enables content-based deduplication. Used for FIFOs only. Sample: True | 
| delay_seconds  integer  | always | The delivery delay in seconds. | 
| kms_data_key_reuse_period_seconds  integer  | always | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. Sample: 300 | 
| kms_master_key_id  string  | always | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. Sample: alias/MyAlias | 
| maximum_message_size  integer  | always | The maximum message size in bytes. Sample: 262144 | 
| message_retention_period  integer  | always | The message retention period in seconds. Sample: 345600 | 
| name  string  | always | Name of the SQS Queue Sample: queuename-987d2de0 | 
| queue_arn  string  | on success | The queue's Amazon resource name (ARN). Sample: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0 | 
| queue_url  string  | on success | URL to access the queue Sample: https://queue.amazonaws.com/123456789012/MyQueue | 
| receive_message_wait_time_seconds  integer  | always | The receive message wait time in seconds. | 
| region  string  | always | Region that the queue was created within Sample: us-east-1 | 
| tags  dictionary  | always | List of queue tags Sample: {"Env": "prod"} | 
| visibility_timeout  integer  | always | The default visibility timeout in seconds. Sample: 30 | 
Authors
- Alan Loi (@loia)
- Fernando Jose Pando (@nand0p)
- Nadir Lloret (@nadirollo)
- Dennis Podkovyrin (@sbj-ss)
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/community/aws/sqs_queue_module.html