community.aws.ses_identity модуль — Управление идентичностью почты и домена SES

Примечание

Этот модуль входит в состав коллекции community.aws (версия 8.0.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в книге задач укажите: community.aws.ses_identity.

Добавлен в community.aws 1.0.0

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

Обзор

Этот модуль позволяет пользователю управлять проверенной электронной почтой и идентификацией домена для SES.
Это включает проверку и удаление идентичностей, а также настройку параметров уведомлений о жалобах, возврате почты и доставке.
До версии 5.0.0 этот модуль назывался community.aws.aws_ses_identity. Использование не изменилось.

Псевдонимы: aws_ses_identity

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные окружения `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Путь к сертификату CA для проверки SSL-сертификатов. Также может использоваться переменная окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bounce_notifications словарь	Настройка темы SNS для отчетов о возврате сообщений. Если опущено, уведомления о возврате сообщений не будут отправлены в тему SNS. Если уведомления о возврате сообщений не отправляются в тему SNS, feedback_forwarding должен быть включен.
include_headers булево	Включать или не включать заголовки при доставке в тему SNS. Если topic не указан, это не повлияет, но настройка SES всё равно будет обновлена, даже если темы нет. Варианты: `false` ← (по умолчанию) `true`
topic строка	ARN темы для отправки уведомлений. Если опущено, уведомления не будут отправлены в тему SNS.
complaint_notifications словарь	Настройка темы SNS для отчетов о жалобах. Если опущено, уведомления о жалобах не будут отправлены в тему SNS. Если уведомления о жалобах не отправляются в тему SNS, feedback_forwarding должен быть включен.
include_headers булево	Включать или не включать заголовки при доставке в тему SNS. Если topic не указан, это не повлияет, но настройка SES всё равно будет обновлена, даже если темы нет. Варианты: `false` ← (по умолчанию) `true`
topic строка	ARN темы для отправки уведомлений. Если опущено, уведомления не будут отправлены в тему SNS.
debug_botocore_endpoint_logs булево	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` API-запросов, сделанных во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода полного списка, сделанного во время выполнения книги задач. Также может использоваться переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
delivery_notifications словарь	Настройка темы SNS для отчетов о доставке сообщений. Если опущено, уведомления о доставке сообщений не будут отправлены в тему SNS.
include_headers булево	Включать или не включать заголовки при доставке в тему SNS. Если topic не указан, это не повлияет, но настройка SES всё равно будет обновлена, даже если темы нет. Варианты: `false` ← (по умолчанию) `true`
topic строка	ARN темы для отправки уведомлений. Если опущено, уведомления не будут отправлены в тему SNS.
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных AWS-точек входа. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут использоваться переменные окружения `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
feedback_forwarding булево	Включить или отключить обратную связь. Может быть только false, если как bounce_notifications, так и complaint_notifications задают темы SNS. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

identity string / required	Это адрес электронной почты или домен, который нужно проверить/удалить. Если строка содержит символ «@», то она интерпретируется как адрес электронной почты. В противном случае — как домен.
profile aliases: aws_profile string	Имя профиля AWS для аутентификации. Дополнительную информацию о профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token.
region aliases: aws_region, ec2_region string	AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удалён в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа AWS. Дополнительную информацию об access token см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Опции secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сессии AWS STS для временных учетных данных. Дополнительную информацию об access token см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN`, или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Опции security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state string	Действие: создание (или обновление) или удаление идентификатора. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	При значении `false`, сертификаты SSL не будут проверяться при общении с API AWS. Сильно не рекомендуется устанавливать validate_certs=false. В качестве альтернативы, можно установить aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому, файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, может также считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

- name: Ensure example@example.com email identity exists
  community.aws.ses_identity:
    identity: example@example.com
    state: present

- name: Delete example@example.com email identity
  community.aws.ses_identity:
    email: example@example.com
    state: absent

- name: Ensure example.com domain identity exists
  community.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.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.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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ses_identity_module.html