community / community.aws / 3.4.0 / module / sqs_queue Creates or deletes AWS SQS queues | "added in version" 1.0.0 of community.aws" Authors: Alan Loi (@loia), Fernando Jose Pando (@nand0p), Nadir Lloret (@nadirollo), Dennis Podkovyrin (@sbj-ss)community.aws.sqs_queue (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create or delete AWS SQS queues.
Update attributes on existing queues.
- 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: Example queue allowing s3 bucket notifications sqs_queue: name: "S3Notifications" default_visibility_timeout: 120 message_retention_period: 86400 maximum_message_size: 1024 delivery_delay: 30 receive_message_wait_time: 20 policy: Version: 2012-10-17 Id: s3-queue-policy Statement: - Sid: allowNotifications Effect: Allow Principal: Service: s3.amazonaws.com Action: - SQS:SendMessage Resource: "arn:aws:sqs:*:*:S3Notifications" Condition: ArnLike: aws:SourceArn: "arn:aws:s3:*:*:SomeBucket"
- name: Delete SQS queue community.aws.sqs_queue: name: my-queue region: ap-southeast-2 state: absent
name: description: - Name of the queue. required: true type: str tags: description: - Tag dict to apply to the queue. - To remove all tags set I(tags={}) and I(purge_tags=true). type: dict state: choices: - present - absent default: present description: - Create or delete the queue. type: str policy: description: - Policy to attach to the queue. - Policy body can be YAML or JSON. - This is required for certain use cases for example with S3 bucket notifications. type: dict 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 purge_tags: default: false description: - Remove tags not listed in I(tags). type: bool queue_type: choices: - standard - fifo default: standard description: - Standard or FIFO queue. - I(queue_type) can only be set at queue creation and will otherwise be ignored. type: str 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 delay_seconds: aliases: - delivery_delay description: - The delivery delay in seconds. type: int 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 redrive_policy: description: - JSON dict with the redrive_policy (see example). type: dict 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 kms_master_key_id: description: - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. - Specifying a valid I(kms_master_key_id) will enable encryption automatically. type: str visibility_timeout: aliases: - default_visibility_timeout description: - The default visibility timeout in seconds. type: int maximum_message_size: description: - The maximum message size in bytes. type: int message_retention_period: description: - The message retention period in seconds. type: int content_based_deduplication: description: - Enables content-based deduplication. Used for FIFOs only. - Defaults to C(false). type: bool 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 kms_data_key_reuse_period_seconds: aliases: - kms_data_key_reuse_period description: - 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. type: int receive_message_wait_time_seconds: aliases: - receive_message_wait_time description: - The receive message wait time in seconds. type: int
content_based_deduplication: description: Enables content-based deduplication. Used for FIFOs only. returned: always sample: true type: bool delay_seconds: description: The delivery delay in seconds. returned: always sample: 0 type: int kms_data_key_reuse_period_seconds: description: 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. returned: always sample: 300 type: int kms_master_key_id: description: The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. returned: if value exists sample: alias/MyAlias type: str 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 success sample: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0 type: str queue_url: description: URL to access the queue returned: on success sample: https://queue.amazonaws.com/123456789012/MyQueue type: str receive_message_wait_time_seconds: 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 tags: description: List of queue tags returned: always sample: '{"Env": "prod"}' type: dict visibility_timeout: description: The default visibility timeout in seconds. returned: always sample: 30 type: int