sns – Send Amazon Simple Notification Service messages — Ansible 2.9

Описание

Отправка уведомления в тему на вашей учётной записи Amazon SNS.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
application - добавлено в 2.8		Сообщения для отправки подписчикам приложения
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 для вывода полного списка, выполненного во время выполнения игры. Так же можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или Eucalyptus облаку (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.
email -		Сообщения для отправки подписчикам по электронной почте.
email_json - добавлено в 2.8		Сообщения для отправки подписчикам по электронной почте в формате JSON.
http -		Сообщения для отправки подписчикам HTTP.
https -		Сообщения для отправки подписчикам HTTPS.
lambda - добавлено в 2.8		Сообщения для отправки подписчикам Lambda.
message_attributes -		Словарь атрибутов сообщения. Это необязательные структурированные данные, которые будут отправлены на конечную точку. Формат соответствует AWS: Имя/Тип/Значение; см. пример ниже.
message_structure -	Варианты: json ← строка	Формат данных для сообщения. Должно быть 'json' для поддержки сообщений, специфичных для протокола (`http`, `https`, `email`, `sms`, `sqs`). Должно быть 'string' для поддержки message_attributes.
msg - / обязательно		Стандартное сообщение для подписчиков без более конкретного сообщения. псевдонимы: default
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
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
sms -		Сообщения для отправки подписчикам SMS.
sqs -		Сообщения для отправки подписчикам SQS.
subject -		Тема сообщения
topic - / обязательно		Имя или ARN темы, в которую будет отправлено сообщение.
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

Примеры

- 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

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

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

Ключ	Возвращаемое значение	Описание
message_id строка	при успехе	ID сообщения, отправленного в модуле Пример: 2f681ef0-6d76-5c94-99b2-4ae3996ce57b
msg строка	всегда	Информация для диагностики человека Пример: OK

Статус

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

Авторы

Michael J. Schultz (@mjschultz)
Paul Arthur (@flowerysong)

Подсказка

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

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

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

Описание

Требования

Параметры

Примечания

Примеры

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

Статус

Авторы