Try SpotterCreates or deletes AWS SQS queues.
| "added in version" 2.0 of ansible.builtin"
Authors: Alan Loi (@loia), Fernando Jose Pando (@nand0p), Nadir Lloret (@nadirollo)
stableinterface | supported by community
pipInstall with pip install ansible==2.9.17
Create or delete AWS SQS queues.
Update attributes on existing queues.
# 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
name:
description:
- Name of the queue.
required: true
state:
choices:
- present
- absent
default: present
description:
- Create or delete the queue
required: false
policy:
description:
- The json dict policy to attach to queue
version_added: '2.1'
version_added_collection: ansible.builtin
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
delivery_delay:
description:
- The delivery delay in seconds.
redrive_policy:
description:
- json dict with the redrive_policy (see example)
version_added: '2.2'
version_added_collection: ansible.builtin
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
maximum_message_size:
description:
- The maximum message size in bytes.
message_retention_period:
description:
- The message retention period in seconds.
receive_message_wait_time:
description:
- The receive message wait time in seconds.
default_visibility_timeout:
description:
- The default visibility timeout in seconds.
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
default_visibility_timeout: description: The default visibility timeout in seconds. returned: always sample: 30 type: int delivery_delay: description: The delivery delay in seconds. returned: always sample: 0 type: int maximum_message_size: description: The maximum message size in bytes. returned: always sample: 262144 type: int message_retention_period: description: The message retention period in seconds. returned: always sample: 345600 type: int name: description: Name of the SQS Queue returned: always sample: queuename-987d2de0 type: str queue_arn: description: The queue's Amazon resource name (ARN). returned: on successful creation or update of the queue sample: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0 type: str receive_message_wait_time: description: The receive message wait time in seconds. returned: always sample: 0 type: int region: description: Region that the queue was created within returned: always sample: us-east-1 type: str