Spec-Zone.ru › Ansible 2.6

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.
topic
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
include_headers
bool
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при доставке в тему SNS.
Если topic не указан, это не повлияет, но параметры SES будут обновлены даже если тема отсутствует.
complaint_notifications
Настройка темы SNS для отчетов о жалобах.
Если опущено, уведомления о жалобах не будут отправлены в тему SNS.
Если уведомления о жалобах не отправляются в тему SNS, необходимо включить feedback_forwarding.
topic
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
include_headers
bool
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при доставке в тему SNS.
Если topic не указан, это не повлияет, но параметры SES будут обновлены даже если тема отсутствует.
delivery_notifications
Настройка темы SNS для отчетов о доставке.
Если опущено, уведомления о доставке не будут отправлены в тему SNS.
topic
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
include_headers
bool
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при доставке в тему SNS.
Если topic не указан, это не повлияет, но параметры SES будут обновлены даже если тема отсутствует.
ec2_url
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
feedback_forwarding
bool
    Варианты:
  • нет
  • да ←
Включить или выключить переадресацию отзывов.
Это может быть false только в том случае, если как bounce_notifications, так и complaint_notifications указывают темы SNS.
identity
обязательно
Это адрес электронной почты или домен для проверки/удаления.
Если это содержит символ «@», это считается адресом электронной почты. В противном случае это считается доменом.
profile
(добавлен в 1.6)
Использует профиль 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
(добавлен в 1.6)
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
state
    Варианты:
  • present ←
  • absent
Создать (или обновить) или удалить идентификатор.
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

Примеры

# 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
  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
  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. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/aws_ses_identity_module.html

Spec-Zone.ru

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