W3cubDocs

/Ansible

sqs_queue - Creates or deletes AWS SQS queues.

New in version 2.0.

Synopsis

  • Create or delete AWS SQS queues.
  • Update attributes on existing queues.

Requirements (on host that executes module)

  • boto
  • boto >= 2.33.0
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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.
aliases: ec2_access_key, access_key
aws_secret_key
 no
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.
aliases: ec2_secret_key, secret_key
default_visibility_timeout
 no
The default visibility timeout in seconds.
delivery_delay
 no
The delivery delay in seconds.
ec2_url
 no
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.
maximum_message_size
 no
The maximum message size in bytes.
message_retention_period
 no
The message retention period in seconds.
name
 yes
Name of the queue.
policy
(added in 2.1)
 no
The json dict policy to attach to queue
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
receive_message_wait_time
 no
The receive message wait time in seconds.
redrive_policy
(added in 2.2)
 no
json dict with the redrive_policy (see example)
region
 no
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
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
state
 no present
  • present
  • absent
Create or delete the queue
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Create SQS queue with redrive policy
- 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

# Delete SQS queue
- sqs_queue:
    name: my-queue
    region: ap-southeast-2
    state: absent

Return Values

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

name description returned type sample
message_retention_period
The message retention period in seconds.
 always int 345600
name
Name of the SQS Queue
 always string queuename-987d2de0
delivery_delay
The delivery delay in seconds.
 always int 0
default_visibility_timeout
The default visibility timeout in seconds.
 always int 30
region
Region that the queue was created within
 always string us-east-1
queue_arn
The queue's Amazon resource name (ARN).
 on successful creation or update of the queue string arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0
maximum_message_size
The maximum message size in bytes.
 always int 262144
receive_message_wait_time
The receive message wait time in seconds.
 always int 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_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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/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

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/sqs_queue_module.html