sqs_queue

Creates or deletes AWS SQS queues

Collection: community.aws

Full Name: community.aws.sqs_queue

Synopsis

Creates or deletes AWS SQS queues

Parameters

Name	Type	Required	Default
access_key	str
aws_ca_bundle	path
aws_config	dict
content_based_deduplication	bool
debug_botocore_endpoint_logs	bool		`false`
deduplication_scope	str
delay_seconds	int
endpoint_url	str
fifo_throughput_limit	str
kms_data_key_reuse_period_seconds	int
kms_master_key_id	str
maximum_message_size	int
message_retention_period	int
name	str	yes
policy	dict
profile	str
purge_tags	bool		`true`
queue_type	str		`standard`
receive_message_wait_time_seconds	int
redrive_policy	dict
region	str
secret_key	str
session_token	str
state	str		`present`
tags	dict
validate_certs	bool		`true`
visibility_timeout	int

Example

yaml

- 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: true

- 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
  community.aws.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