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 Name/Type/Value; см. пример ниже. | |
| message_structure - / обязательно |
| Формат данных для сообщения. Должно быть 'json' для поддержки сообщений по умолчанию (`http`, `https`, `email`, `sms`, `sqs`). Должно быть 'строка' для поддержки 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 boolean добавлен в 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), если учетные данные не предоставлены. См. 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
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/sns_module.html