Spec-Zone.ru › Ansible 2.7

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
boolean
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
complaint_notifications
-
Настройка темы SNS для отчетов о жалобах.
Если опущено, уведомления о жалобах не будут отправлены в тему SNS.
Если уведомления о жалобах не отправляются в тему SNS, необходимо включить feedback_forwarding.
include_headers
boolean
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
delivery_notifications
-
Настройка темы SNS для отчетов о доставке.
Если опущено, уведомления о доставке не будут отправлены в тему SNS.
include_headers
boolean
    Варианты:
  • нет ←
  • да
Включать или нет заголовки при отправке в тему SNS.
Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если тема отсутствует.
topic
-
ARN темы для отправки уведомлений.
Если опущено, уведомления не будут отправлены в тему SNS.
ec2_url
-
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
feedback_forwarding
boolean
    Варианты:
  • нет
  • да ←
Включить или выключить переадресацию отзывов.
Это может быть только 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
boolean
добавлено в 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), если учетные данные не предоставлены. См. 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. [community]

Авторы

  • 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.7/modules/aws_ses_identity_module.html

Spec-Zone.ru

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