Spec-Zone.ru › Ansible 2.4

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
нет present
  • present
  • absent
Создать или удалить очередь
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
Если установлено "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверяться.

Примеры

# 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 0
maximum_message_size
Максимальный размер сообщения в байтах.
всегда int 262144
message_retention_period
Срок хранения сообщений в секундах.
всегда int 345600
name
Имя очереди SQS
всегда строка queuename-987d2de0
queue_arn
Идентификатор ресурса очереди Amazon (ARN).
при успешном создании или обновлении очереди строка arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0
receive_message_wait_time
Время ожидания получения сообщения в секундах.
всегда int 0
region
Регион, в котором была создана очередь
всегда строка us-east-1

Примечания

Примечание

  • Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета 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

Статус

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

Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API