community.aws.aws_ses_identity – Управление адресами электронной почты и идентичностью домена SES
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Чтобы использовать его в книге задач, укажите: community.aws.aws_ses_identity.
Новое в версии 1.0.0: из community.aws
Обзор
- Этот модуль позволяет пользователю управлять проверенными адресами электронной почты и идентичностью домена для SES.
- Это включает в себя проверку и удаление идентичностей, а также настройку параметров уведомлений о жалобах, возвращенных письмах и доставке.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: ec2_access_key, access_key | ||
| aws_ca_bundle путь | Расположение файла с набором сертификатов CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: набор сертификатов CA читается на стороне модуля и, возможно, требует явного копирования из контроллера, если модуль не выполняется локально. | ||
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | ||
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет исключено после 2022-06-01. псевдонимы: 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 логическое значение |
| Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводить набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы выводить в общий список, созданный во время выполнения игры. | |
| delivery_notifications словарь | Настройка темы SNS для уведомлений об успешной доставке. Если не указана, уведомления об успешной доставке не будут отправлены в тему SNS. | ||
| include_headers логическое значение |
| Включать или нет заголовки при отправке в тему SNS. Если topic не указан, это не повлияет, но настройки SES будут обновлены, даже если темы нет. | |
| topic строка | ARN темы, в которую нужно отправить уведомления. Если не указана, уведомления не будут отправлены в тему SNS. | ||
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url | ||
| feedback_forwarding логическое значение |
| Включить или выключить перенаправление обратной связи. Может быть выключено только в том случае, если оба bounce_notifications и complaint_notifications указывают темы SNS. | |
| identity строка / обязательно | Это адрес электронной почты или домен для проверки/удаления. Если строка содержит «@», она считается адресом электронной почты. В противном случае она считается доменом. | ||
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token. Поддержка одновременного использования этих параметров с profile устарела. aws_access_key, aws_secret_key и security_token будут исключены после 2022-06-01. псевдонимы: aws_profile | ||
| 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. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. псевдонимы: aws_security_token, access_token | ||
| state строка |
| Создать (или обновить) или удалить идентификатор. | |
| validate_certs логическое значение |
| Если установлено «нет», SSL-сертификаты для boto-версий >= 2.6.0 не будут проверены. | |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные среды могут быть использованы в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - 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
community.aws.aws_ses_identity:
identity: example@example.com
state: present
- name: Delete example@example.com email identity
community.aws.aws_ses_identity:
email: example@example.com
state: absent
- name: Ensure example.com domain identity exists
community.aws.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
community.aws.sns_topic:
name: "complaints-topic"
state: present
purge_subscriptions: False
register: topic_info
- name: Deliver feedback to topic instead of owner email
community.aws.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
community.aws.sns_topic:
name: "delivery-notifications-topic"
state: present
purge_subscriptions: False
register: topic_info
- name: Delivery notifications to topic
community.aws.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 строка | успех | Токен проверки для идентификатора домена. | |
Авторы
- 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.10/collections/community/aws/aws_ses_identity_module.html