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

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

Описание

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

Требования

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

boto
boto >= 2.33.0
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs булево добавлен в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводить набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в список всех вызовов во время выполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
default_visibility_timeout -		Время ожидания видимости по умолчанию в секундах.
delivery_delay -		Задержка доставки в секундах.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая есть.
maximum_message_size -		Максимальный размер сообщения в байтах.
message_retention_period -		Срок хранения сообщений в секундах.
name - / обязательно		Имя очереди.
policy -		Политика json-словаря, которая будет применена к очереди
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
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. псевдонимы: access_token
state -	Варианты: present ← absent	Создать или удалить очередь
validate_certs булево	Варианты: нет да ←	Если установлено значение "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, 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
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# 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

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

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

Ключ	Возвращаемое значение	Описание
default_visibility_timeout целое число	всегда	Время ожидания видимости по умолчанию в секундах. Пример: 30
delivery_delay целое число	всегда	Задержка доставки в секундах.
maximum_message_size целое число	всегда	Максимальный размер сообщения в байтах. Пример: 262144
message_retention_period целое число	всегда	Срок хранения сообщений в секундах. Пример: 345600
name строка	всегда	Имя очереди SQS Пример: queuename-987d2de0
queue_arn строка	при успешном создании или обновлении очереди	Amazon Resource Name (ARN) очереди. Пример: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0
receive_message_wait_time целое число	всегда	Время ожидания получения сообщения в секундах.
region строка	всегда	Регион, в котором была создана очередь. Пример: us-east-1

Статус

Данный модуль гарантирует обратную совместимость изменений интерфейса в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Alan Loi (@loia)
Fernando Jose Pando (@nand0p)
Nadir Lloret (@nadirollo)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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