aws_ses_identity - Управление идентификаторами электронной почты и доменами SES
Новая версия 2.5.
Обзор
- Этот модуль позволяет пользователю управлять проверенными адресами электронной почты и идентификаторами доменов для SES.
- Он охватывает проверку и удаление идентификаторов, а также настройку параметров уведомлений о жалобах, отказах и доставке.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ 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 |
| Включать или нет заголовки при отправке в тему SNS. Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если темы нет. | |
| complaint_notifications | Настройка темы SNS для отчетов о жалобах. Если опущено, уведомления о жалобах не будут отправляться в тему SNS. Если уведомления о жалобах не отправляются в тему SNS, feedback_forwarding должен быть включен. | ||
| topic | ARN темы для отправки уведомлений. Если опущено, уведомления не будут отправляться в тему SNS. | ||
| include_headers |
| Включать или нет заголовки при отправке в тему SNS. Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если темы нет. | |
| delivery_notifications | Настройка темы SNS для отчетов о доставке. Если опущено, уведомления о доставке не будут отправляться в тему SNS. | ||
| topic | ARN темы для отправки уведомлений. Если опущено, уведомления не будут отправляться в тему SNS. | ||
| include_headers |
| Включать или нет заголовки при отправке в тему SNS. Если topic не указан, это не повлияет, но настройка SES будет обновлена, даже если темы нет. | |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. | |
| feedback_forwarding |
| Включить или выключить переадресацию обратной связи. Может быть только false, если в bounce_notifications и complaint_notifications указаны темы SNS. | |
| identity обязательно | Адрес электронной почты или домен для проверки/удаления. Если содержит «@», считается адресом электронной почты. В противном случае считается доменом. | ||
| profile (добавлен в 1.6) | Значение по умолчанию: None | Использует профиль 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) | Значение по умолчанию: None | AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state |
| Создавать (или обновлять) или удалять идентификатор. | |
| validate_certs (добавлен в 1.5) |
| В случае значения «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
Примеры
# 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 }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| error сложный | при ошибке клиента от AWS | Подробности ответа об ошибке от AWS. Пример: {'message': 'Тема уведомления обратной связи не установлена.', 'code': 'InvalidParameterValue', 'type': 'Sender'} | |
| message строка | Сообщение об ошибке AWS. | ||
| code строка | Код ошибки AWS. | ||
| type строка | Тип ошибки AWS. | ||
| identity строка | успех | Идентификатор, который изменяется. Пример: example@example.com | |
| identity_arn строка | успех | ARN идентификатора, который изменяется. Пример: arn:aws:ses:us-east-1:12345678:identity/example@example.com | |
| notification_attributes сложный | успех | Настройки уведомлений для идентификатора. Пример: {'complaint_topic': 'arn:aws:sns:....', 'bounce_topic': 'arn:aws:sns:....', 'delivery_topic': 'arn:aws:sns:....', 'forwarding_enabled': False, 'headers_in_delivery_notifications_enabled': True, 'headers_in_complaint_notifications_enabled': True, 'headers_in_bounce_notifications_enabled': True} | |
| complaint_topic строка | ARN темы, в которую доставляются уведомления о жалобах. Опущено, если уведомления о жалобах не доставляются в тему. | ||
| bounce_topic строка | ARN темы, в которую доставляются уведомления о возврате. Опущено, если уведомления о возврате не доставляются в тему. | ||
| delivery_topic строка | ARN темы, в которую доставляются уведомления о доставке. Опущено, если уведомления о доставке не доставляются в тему. | ||
| forwarding_enabled логическое | Включена ли пересылка обратной связи. | ||
| headers_in_delivery_notifications_enabled логическое | Включаются ли заголовки в сообщения, отправленные в тему доставки. | ||
| headers_in_complaint_notifications_enabled логическое | Включаются ли заголовки в сообщения, отправленные в тему жалоб. | ||
| headers_in_bounce_notifications_enabled логическое | Включаются ли заголовки в сообщения, отправленные в тему возврата. | ||
| verification_attributes сложный | успех | Информация о проверке идентификатора. Пример: {'verification_status': 'Ожидание', 'verification_token': '....'} | |
| verification_status строка | Статус проверки идентификатора. Пример: Ожидание | ||
| verification_token строка | Токен проверки для идентификатора домена. | ||
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Эд Костелло (@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.5/modules/aws_ses_identity_module.html