community.aws.sqs_queue – Создаёт или удаляет очереди AWS SQS

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.sqs_queue.

Добавлена в версии 1.0.0: из community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Создание или удаление очередей AWS SQS.
Обновление атрибутов существующих очередей.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если установлен параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с сертификатом CA Bundle для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: сертификат CA Bundle считывается со стороны модуля и может потребоваться явное копирование с контроллера, если запуск не происходит локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если установлен параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
content_based_deduplication логическое	Варианты: нет да	Включает дублирование на основе содержимого. Используется только для очередей FIFO. По умолчанию `false`.
debug_botocore_endpoint_logs логическое	Варианты: нет ← да	Использует логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", совершённых во время задачи, выводит множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
delay_seconds целое число		Задержка доставки в секундах. псевдонимы: delivery_delay
ec2_url строка		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не установлен, используется значение переменной окружения EC2_URL, если она задана. псевдонимы: aws_endpoint_url, endpoint_url
kms_data_key_reuse_period_seconds целое число		Срок, в секундах, на протяжении которого Amazon SQS может повторно использовать ключ данных для шифрования или расшифровки сообщений перед обращением к AWS KMS. псевдонимы: kms_data_key_reuse_period
kms_master_key_id строка		Идентификатор управляемого AWS ключа главного клиента (CMK) для Amazon SQS или пользовательского CMK.
maximum_message_size целое число		Максимальный размер сообщения в байтах.
message_retention_period целое число		Срок хранения сообщения в секундах.
name строка / обязательно		Имя очереди.
policy словарь		Словарь JSON с политикой, которую необходимо прикрепить к очереди.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их передачи одновременно с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
purge_tags логическое	Варианты: нет ← да	Удаление тегов, не указанных в tags.
queue_type строка	Варианты: стандартная ← fifo	Стандартная или FIFO очередь. queue_type может быть установлен только при создании очереди и в противном случае будет проигнорирован.
receive_message_wait_time_seconds целое число		Время ожидания получения сообщения в секундах. псевдонимы: receive_message_wait_time
redrive_policy словарь		Словарь JSON с redrive_policy (см. пример).
region строка		AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она задана. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Создать или удалить очередь.
tags словарь		Словарь тегов для применения к очереди (требуется botocore 1.5.40 или выше). Для удаления всех тегов установите tags={} и purge_tags=true.
validate_certs логическое	Варианты: нет да ←	При установке в "нет", SSL сертификаты не будут проверяться для версий boto >= 2.6.0.
visibility_timeout целое число		Значение тайм-аута видимости по умолчанию в секундах. псевдонимы: default_visibility_timeout

Примечания

Примечание

Если параметры не установлены в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS региона, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
content_based_deduplication boolean	всегда	Включает дублирование по содержанию. Используется только для FIFOs. Пример: True
delay_seconds integer	всегда	Задержка доставки в секундах.
kms_data_key_reuse_period_seconds integer	всегда	Время в секундах, в течение которого Amazon SQS может повторно использовать ключ данных для шифрования или дешифрования сообщений перед обращением к AWS KMS снова. Пример: 300
kms_master_key_id string	всегда	Идентификатор управляемого AWS ключа шифрования (CMK) для Amazon SQS или настраиваемого CMK. Пример: alias/MyAlias
maximum_message_size integer	всегда	Максимальный размер сообщения в байтах. Пример: 262144
message_retention_period integer	всегда	Срок хранения сообщений в секундах. Пример: 345600
name string	всегда	Имя очереди SQS Пример: queuename-987d2de0
queue_arn string	при успехе	Идентификатор ресурса Amazon (ARN) очереди. Пример: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0
queue_url string	при успехе	URL для доступа к очереди Пример: https://queue.amazonaws.com/123456789012/MyQueue
receive_message_wait_time_seconds integer	всегда	Время ожидания получения сообщения в секундах.
region string	всегда	Регион, в котором была создана очередь Пример: us-east-1
tags dictionary	всегда	Список тегов очереди Пример: {"Env": "prod"}
visibility_timeout integer	всегда	Установленное по умолчанию время видимости в секундах. Пример: 30

Авторы

Alan Loi (@loia)
Fernando Jose Pando (@nand0p)
Nadir Lloret (@nadirollo)
Dennis Podkovyrin (@sbj-ss)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/sqs_queue_module.html