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

Новое в версии 2.0.

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

Описание

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

Требования

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

boto
boto >= 2.33.0
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	По умолчанию: None	Ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	По умолчанию: None	Секретный ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
default_visibility_timeout	По умолчанию: None	Значение таймаута видимости по умолчанию в секундах.
delivery_delay	По умолчанию: None	Задержка доставки в секундах.
ec2_url	По умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
maximum_message_size	По умолчанию: None	Максимальный размер сообщения в байтах.
message_retention_period	По умолчанию: None	Срок хранения сообщений в секундах.
name обязательно		Имя очереди.
policy (добавлено в 2.1)	По умолчанию: None	Политика в формате JSON для добавления к очереди
profile (добавлено в 1.6)	По умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
receive_message_wait_time	По умолчанию: None	Время ожидания получения сообщения в секундах.
redrive_policy (добавлено в 2.2)	По умолчанию: None	Словарь 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 (добавлено в 1.6)	По умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	Варианты: present ← absent	Создать или удалить очередь
validate_certs (добавлено в 1.5)	Варианты: no yes ←	Если установлено в "no", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 int	всегда	Значение таймаута видимости по умолчанию в секундах. Пример: 30
delivery_delay int	всегда	Задержка доставки в секундах.
maximum_message_size int	всегда	Максимальный размер сообщения в байтах. Пример: 262144
message_retention_period int	всегда	Срок хранения сообщений в секундах. Пример: 345600
name строка	всегда	Имя очереди SQS Пример: queuename-987d2de0
queue_arn строка	при успешном создании или обновлении очереди	Amazon Resource Name (ARN) очереди. Пример: arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0
receive_message_wait_time int	всегда	Время ожидания получения сообщения в секундах.
region строка	всегда	Регион, в котором была создана очередь Пример: us-east-1

Статус

Этот модуль помечен как stableinterface, что означает, что поддерживающие этот модуль гарантируют, что не будут вноситься обратные несовместимые изменения в интерфейс.

Автор

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.5/modules/sqs_queue_module.html