Spec-Zone.ru › Ansible 2.9

aws_ses_identity – Управление идентичностью электронной почты и доменом SES

Новая версия 2.5.

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

Обзор

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

Требования

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

  • boto
  • boto3
  • botocore
  • 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
bounce_notifications
-
Настройка темы SNS для уведомлений о возврате почты.
Если опущено, уведомления о возврате не будут отправлены в тему SNS.
Если уведомления о возврате не отправляются в тему SNS, необходимо включить feedback_forwarding.
include_headers
логическое значение
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
complaint_notifications
-
Настройка темы SNS для уведомлений о жалобах.
Если опущено, уведомления о жалобах не будут отправлены в тему SNS.
Если уведомления о жалобах не отправляются в тему SNS, необходимо включить feedback_forwarding.
include_headers
логическое значение
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
debug_botocore_endpoint_logs
логическое значение
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения плейбука. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
delivery_notifications
-
Настройка темы SNS для уведомлений о доставке.
Если опущено, уведомления о доставке не будут отправлены в тему SNS.
include_headers
логическое значение
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
ec2_url
строка
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется.
feedback_forwarding
логическое значение
    Варианты:
  • нет
  • да ←
Включить или отключить переадресацию обратной связи.
Это может быть false только в том случае, если как bounce_notifications, так и complaint_notifications указывают темы SNS.
identity
- / обязательно
Адрес электронной почты или домен для проверки/удаления.
Если в этом значении присутствует символ «@», это будет расценено как адрес электронной почты. В противном случае — как домен.
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
state
-
    Варианты:
  • present ←
  • absent
Создать (или обновить) или удалить идентичность.
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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Ensure example@example.com email identity exists
  aws_ses_identity:
    identity: example@example.com
    state: present

- name: Delete example@example.com email identity
  aws_ses_identity:
    email: example@example.com
    state: absent

- name: Ensure example.com domain identity exists
  aws_ses_identity:
    identity: example.com
    state: present

# Create an SNS topic and send bounce and complaint notifications to it
# instead of emailing the identity owner
- name: Ensure complaints-topic exists
  sns_topic:
    name: "complaints-topic"
    state: present
    purge_subscriptions: False
  register: topic_info

- name: Deliver feedback to topic instead of owner email
  aws_ses_identity:
    identity: example@example.com
    state: present
    complaint_notifications:
      topic: "{{ topic_info.sns_arn }}"
      include_headers: True
    bounce_notifications:
      topic: "{{ topic_info.sns_arn }}"
      include_headers: False
    feedback_forwarding: False

# Create an SNS topic for delivery notifications and leave complaints
# Being forwarded to the identity owner email
- name: Ensure delivery-notifications-topic exists
  sns_topic:
    name: "delivery-notifications-topic"
    state: present
    purge_subscriptions: False
  register: topic_info

- name: Delivery notifications to topic
  aws_ses_identity:
    identity: example@example.com
    state: present
    delivery_notifications:
      topic: "{{ topic_info.sns_arn }}"

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

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

Ключ Возвращаемое значение Описание
identity
строка
успех
Изменяемая идентификация.

Пример:
example@example.com
identity_arn
строка
успех
Arn изменяемой идентификации.

Пример:
arn:aws:ses:us-east-1:12345678:identity/example@example.com
notification_attributes
сложная структура
успех
Настройка уведомлений для идентификации.

Пример:
{'bounce_topic': 'arn:aws:sns:....', 'complaint_topic': 'arn:aws:sns:....', 'delivery_topic': 'arn:aws:sns:....', 'forwarding_enabled': False, 'headers_in_bounce_notifications_enabled': True, 'headers_in_complaint_notifications_enabled': True, 'headers_in_delivery_notifications_enabled': True}
bounce_topic
строка
ARN темы, в которую доставляются уведомления о возврате.
Опускается, если уведомления о возврате не доставляются в тему.

complaint_topic
строка
ARN темы, в которую доставляются уведомления о жалобах.
Опускается, если уведомления о жалобах не доставляются в тему.

delivery_topic
строка
ARN темы, в которую доставляются уведомления о доставке.
Опускается, если уведомления о доставке не доставляются в тему.

forwarding_enabled
булево
Включено ли переадресация отзывов.

headers_in_bounce_notifications_enabled
булево
Включаются ли заголовки в сообщения, доставляемые в тему возврата.

headers_in_complaint_notifications_enabled
булево
Включаются ли заголовки в сообщения, доставляемые в тему жалоб.

headers_in_delivery_notifications_enabled
булево
Включаются ли заголовки в сообщения, доставляемые в тему доставки.

verification_attributes
сложная структура
успех
Данные проверки идентификации.

Пример:
{'verification_status': 'Pending', 'verification_token': '....'}
verification_status
строка
Статус проверки идентификации.

Пример:
Pending
verification_token
строка
Токен проверки идентификации домена.



Статус

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

Авторы

  • Ed Costello (@orthanc)

Подсказка

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API