sns module – Send Amazon Simple Notification Service messages — Ansible

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
application string	Сообщение для отправки подпискам приложения.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, сделанный во время выполнения playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
email string	Сообщение для отправки подпискам электронной почты.
email_json string	Сообщение для отправки подпискам email-json.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
http string	Сообщение для отправки подпискам HTTP.
https string	Сообщение для отправки подпискам HTTPS.
lambda string	Сообщение для отправки подпискам Lambda.
message_attributes dictionary	Словарь атрибутов сообщения. Это необязательные записи структурированных данных, которые будут отправлены в конечную точку. Это в собственном формате AWS Имя/Тип/Значение; см. пример ниже.
message_deduplication_id string добавлено в community.aws 5.4.0	Только в сочетании с message_group_id. Перезаписывает автоматически сгенерированный MessageDeduplicationId. Может содержать до 128 буквенно-цифровых символов и знаков препинания. Сообщения с одинаковым идентификатором дедупликации распознаются как одно и то же сообщение. Перезаписывается автоматически сгенерированным токеном, если для темы установлен ContentBasedDeduplication.
message_group_id string добавлено в community.aws 5.4.0	Тег, используемый для обработки сообщений, принадлежащих к одной группе, в режиме FIFO. Должен быть включен при публикации сообщения в тему fifo. Может содержать до 128 буквенно-цифровых символов и знаков препинания.
message_structure string	Формат полезной нагрузки для сообщения. Это должно быть `json` для поддержки сообщений, специфичных для протокола (`http`, `https`, `email`, `sms`, `sqs`). Это должно быть `string` для поддержки message_attributes. Варианты: `"json"` ← (по умолчанию) `"string"`
msg aliases: default string / required	Сообщение по умолчанию для подписок без более конкретного сообщения.

профиль псевдонимы: aws_profile строка	Используемый профиль AWS для аутентификации. Для получения дополнительной информации о профилях см. документацию AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр профиль взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
регион псевдонимы: aws_region, ec2_region строка	Используемый AWS-регион. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр регион игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удалён в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в выпуске после 2024-12-01.
секретный_ключ псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры секретный_ключ и профиль взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в выпуске после 2024-12-01.
токен_сессии псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	Токен сессии AWS STS для использования с временными учётными данными. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры токен_сессии и профиль взаимоисключающие. Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в выпуске после 2024-12-01.
sms строка	Сообщение для отправки подписчикам SMS.
sqs строка	Сообщение для отправки подписчикам SQS.
тема строка	Тема сообщения
тема строка / обязательно	Имя или ARN темы, в которую необходимо опубликовать.
проверка_сертификатов булево	При установке в `false`, сертификаты SSL для связи с AWS API не будут проверяться. Установка проверка_сертификатов=false крайне не рекомендуется; в качестве альтернативы, рассмотрите возможность установки aws_ca_bundle. Выбор: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому, возможно, потребуется явно скопировать файлы на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
Используемый AWS SDK (boto3) Ansible также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: Send default notification message via SNS
  community.aws.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
  community.aws.sns:
    msg: '{{ inventory_hostname }} has completed the play.'
    sms: deployed!
    subject: Deploy complete!
    topic: deploy
  delegate_to: localhost

- name: Send message with message_attributes
  community.aws.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

- name: Send message to a fifo topic
  community.aws.sns:
    topic: "deploy"
    msg: "Message with message group id"
    subject: Deploy complete!
    message_group_id: "deploy-1"
  delegate_to: localhost

Значения возврата

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

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

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/sns_module.html

Модуль community.aws.sns — Отправка сообщений Amazon Simple Notification Service