sns_topic — Ansible 2.4

Обзор
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

Обзор

Модуль sns_topic позволяет создавать, удалять и управлять подписками на темы AWS SNS.

Требования (к хосту, на котором выполняется модуль)

boto
python >= 2.6

Параметры

Параметр	Обязательный	Значение по умолчанию	Варианты	Комментарии
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
delivery_policy	нет	None		Политика доставки, применяемая к теме SNS
display_name	нет	None		Имя темы для отображения
ec2_url	нет			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
name	да			Имя или ARN темы SNS для слияния
policy	нет	None		Политика, применяемая к теме SNS
profile (добавлен в 1.6)	нет			Использует профиль boto. Работает только с boto >= 2.24.0.
purge_subscriptions	нет	True		Необходимо ли очистить подписки, не указанные здесь. ПРИМЕЧАНИЕ: AWS не позволяет очистить подписки PendingConfirmation, поэтому, если они существуют и должны быть удалены, они проигнорируются. Это означает, что кто-то может вернуться позже и подтвердить подписку. Извините. Вина Амазона.
security_token (добавлен в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	нет	present	absent present	Создавать или удалять тему SNS
subscriptions	нет			Список подписок, применяемых к теме. Обратите внимание, что AWS требует подтверждения подписок, поэтому вам необходимо подтвердить все новые подписки.
validate_certs (добавлен в 1.5)	нет	yes	yes no	При значении "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

- name: Create alarm SNS topic
  sns_topic:
    name: "alarms"
    state: present
    display_name: "alarm SNS topic"
    delivery_policy:
      http:
        defaultHealthyRetryPolicy:
            minDelayTarget: 2
            maxDelayTarget: 4
            numRetries: 3
            numMaxDelayRetries: 5
            backoffFunction: "<linear|arithmetic|geometric|exponential>"
        disableSubscriptionOverrides: True
        defaultThrottlePolicy:
            maxReceivesPerSecond: 10
    subscriptions:
      - endpoint: "my_email_address@example.com"
        protocol: "email"
      - endpoint: "my_mobile_number"
        protocol: "sms"

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

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

Имя	Описание	Возвращается	Тип	Пример
sns_arn	ARN темы, которую вы изменяете	всегда	строка	arn:aws:sns:us-east-1:123456789012:my_topic_name
sns_topic	Словарь с деталями темы SNS	всегда	словарь	{'subscriptions_new': [], 'subscriptions_deleted': [], 'topic_deleted': False, 'display_name': 'default', 'name': 'sns-topic-name', 'attributes_set': [], 'delivery_policy': {}, 'check_mode': False, "subscriptions_purge'": False, 'topic_created': False, 'state': 'present', 'policy': {}, 'subscriptions_existing': [], 'subscriptions_added': []}

Примечания

Примечание

Если параметры не заданы в модуле, следующие переменные окружения могут использоваться в порядке убывания приоритета 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

Статус

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

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/sns_topic_module.html