sns – Send Amazon Simple Notification Service messages — Ansible 2.8

Обзор

Отправляет уведомление на тему в вашей учетной записи 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:action», выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения playbook. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует.
email -		Сообщение для отправки подпискам по электронной почте.
email_json - добавлен в 2.8		Сообщение для отправки подпискам email-json.
http -		Сообщение для отправки подпискам HTTP.
https -		Сообщение для отправки подпискам HTTPS.
lambda - добавлен в 2.8		Сообщение для отправки подпискам Lambda.
message_attributes -		Словарь атрибутов сообщения. Это необязательные структурированные данные, которые будут отправлены на конечную точку. Этот формат соответствует AWS (Название/Тип/Значение); см. пример ниже.
message_structure -	Варианты: json ← строка	Формат полезной нагрузки для сообщения. Он должен быть 'json', чтобы поддерживать сообщения, специфичные для протокола (`http`, `https`, `email`, `sms`, `sqs`). Он должен быть 'строка', чтобы поддерживать 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 строка	при успехе	Идентификатор сообщения, отправленного сообщений Пример: 2f681ef0-6d76-5c94-99b2-4ae3996ce57b
msg строка	всегда	Информация о диагностике для чтения человеком Пример: OK

Статус

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

Авторы

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

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

Обзор

Требования

Параметры

Примечания

Примеры

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

Статус

Авторы