Spec-Zone.ru › Ansible 2.6

sns - Отправка сообщений Amazon Simple Notification Service (SNS)

Новая версия 1.6.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

  • Модуль sns отправляет уведомления на тему в вашей учетной записи Amazon SNS

Требования

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

  • boto
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
ec2_url
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где необходима область. Должен быть указан для всех других модулей, если область не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.
email
Сообщение для отправки подписке только по электронной почте
http
Сообщение для отправки подписке только по HTTP
https
Сообщение для отправки подписке только по HTTPS
message_attributes
Словарь атрибутов сообщения. Это необязательные структурированные данные, которые отправляются вместе с конечной точкой.
Формат данных в стиле AWS (Имя/Тип/Значение); см. пример ниже.
message_structure
обязательно
    Варианты:
  • json ←
  • строка
Формат данных для использования в сообщении.
Должно быть 'json' для поддержки сообщений по умолчанию (`http`, `https`, `email`, `sms`, `sqs`). Должно быть 'string' для поддержки message_attributes.
msg
обязательно
Сообщение по умолчанию для отправки.

Псевдонимы: default
profile
(добавлено в 1.6)
Использует профиль boto. Работает только с boto >= 2.24.0.
region
AWS регион для использования. Если не указан, используется значение переменной среды EC2_REGION, если она есть.

Псевдонимы: aws_region, ec2_region
security_token
(добавлено в 1.6)
AWS STS токен безопасности. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
sms
Сообщение для отправки подписке только по SMS
sqs
Сообщение для отправки подписке только по SQS
subject
Тема для доставки по электронной почте.
topic
обязательно
Тема, на которую нужно опубликовать сообщение.
validate_certs
bool

(добавлено в 1.5)
    Варианты:
  • нет
  • да ←
Если установлено «нет», сертификаты 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

Примеры

- name: Send default notification message via SNS
  sns:
    msg: '{{ inventory_hostname }} has completed the play.'
    subject: Deploy complete!
    topic: deploy
  delegate_to: localhost

- name: Send notification messages via SNS with short message for SMS
  sns:
    msg: '{{ inventory_hostname }} has completed the play.'
    sms: deployed!
    subject: Deploy complete!
    topic: deploy
  delegate_to: localhost

- name: Send message with message_attributes
  sns:
    topic: "deploy"
    msg: "message with extra details!"
    message_attributes:
      channel:
        data_type: String
        string_value: "mychannel"
      color:
        data_type: String
        string_value: "green"
  delegate_to: localhost

Статус

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

Техническое обслуживание

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

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • Michael J. Schultz (@mjschultz)

Подсказка

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

© 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/sns_module.html

Spec-Zone.ru

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