sqs_queue - Создаёт или удаляет очереди AWS SQS.
Новое в версии 2.0.
Обзор
- Создаёт или удаляет очереди 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 | |
| default_visibility_timeout | Время ожидания видимости по умолчанию в секундах. | |
| delivery_delay | Задержка доставки в секундах. | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она задана. | |
| maximum_message_size | Максимальный размер сообщения в байтах. | |
| message_retention_period | Срок хранения сообщений в секундах. | |
| name обязательно | Имя очереди. | |
| policy (добавлено в 2.1) | Политика в формате JSON для добавления к очереди | |
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| receive_message_wait_time | Время ожидания получения сообщения в секундах. | |
| redrive_policy (добавлено в 2.2) | Словарь 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) | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state |
| Создать или удалить очередь |
| validate_certs bool (добавлено в 1.5) |
| При установке в «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, что означает, что разработчики этого модуля гарантируют отсутствие изменений интерфейса, несовместимых со старыми версиями.
Техническое обслуживание
Этот модуль помечен как certified, что означает, что он поддерживается партнером Ansible. Дополнительная информация о поддержке и обслуживании модулей представлена в разделе Поддержка и обслуживание модулей.
Список других модулей, также поддерживаемых партнером Ansible, см. здесь.
Автор
- 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.6/modules/sqs_queue_module.html