sns_topic — Ansible 2.5

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Требования

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

boto
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	По умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
aws_secret_key	По умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
delivery_policy	По умолчанию: None	Политика доставки для темы SNS
display_name	По умолчанию: None	Имя темы для отображения
ec2_url	По умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL (если она есть).
name обязательно		Имя или ARN темы SNS, которую необходимо согласовать.
policy	По умолчанию: None	Политика, применяемая к теме SNS.
profile (добавлен в 1.6)	По умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
purge_subscriptions	По умолчанию: yes	Удалить подписки, которые не указаны здесь. ПРИМЕЧАНИЕ: AWS не позволяет очищать подписки PendingConfirmation, поэтому, если они существуют и должны быть удалены, они будут пропущены. Это означает, что кто-то может вернуться позже и подтвердить подписку. Извините. Виновата Amazon.
region		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION (если она есть). См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
security_token (добавлен в 1.6)	По умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
state	Варианты: absent present ←	Создать или удалить тему SNS
subscriptions	По умолчанию: []	Список подписок, применяемых к теме. Обратите внимание, что AWS требует подтверждения подписок, поэтому вам необходимо подтвердить любые новые подписки.
validate_certs (добавлен в 1.5)	Варианты: no yes ←	Если установлено "no", сертификаты 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), если данные для аутентификации не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION можно использовать для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto

Примеры

- 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': []}

Статус

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

Автор

Joel Thompson (@joelthompson)
Fernando Jose Pando (@nand0p)

Подсказка

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

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

sns_topic - Управляет темами и подписками AWS SNS

Обзор

Требования

Параметры

Примечания

Примеры

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

Статус

Автор