sns_topic — Ansible 2.6

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

Обзор

Модуль 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		Политика доставки, применяемая к теме SNS
display_name		Имя темы для отображения
ec2_url		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
name обязательно		Имя или ARN темы SNS для слияния
policy		Политика, применяемая к теме SNS
profile (добавлен в 1.6)		Использует профиль boto. Работает только с boto >= 2.24.0.
purge_subscriptions	По умолчанию: "да"	Удалить подписки, не указанные здесь. ПРИМЕЧАНИЕ: AWS не позволяет удалять подписки в статусе PendingConfirmation, поэтому если они существуют и должны быть удалены, то они пропустятся. Это означает, что кто-то может вернуться позже и подтвердить подписку. Извините. В вину Amazon.
region		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region Псевдонимы: aws_region, ec2_region
security_token (добавлен в 1.6)		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	Варианты: absent present ←	Создать или удалить тему SNS
subscriptions	По умолчанию: []	Список подписок, которые необходимо применить к теме. Обратите внимание, что AWS требует подтверждения подписок, поэтому вам необходимо подтвердить все новые подписки.
validate_certs bool (добавлен в 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), если учетные данные не предоставлены. См. 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 Пример: {'name': 'sns-topic-name', 'state': 'present', 'display_name': 'default', 'policy': {}, 'delivery_policy': {}, 'subscriptions_new': [], 'subscriptions_existing': [], 'subscriptions_deleted': [], 'subscriptions_added': [], "subscriptions_purge'": False, 'check_mode': False, 'topic_created': False, 'topic_deleted': False, 'attributes_set': []}

Статус

Данный модуль помечен как stableinterface, что означает, что поддерживающие его специалисты гарантируют отсутствие несовместимых изменений интерфейса.

Техническое обслуживание

Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнером Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых партнером Ansible, см. здесь.

Автор

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.6/modules/sns_topic_module.html

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

Обзор

Требования

Параметры

Примечания

Примеры

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

Статус

Техническое обслуживание

Автор