Spec-Zone.ru › Ansible

Модуль community.aws.ses_identity — управление идентификаторами электронной почты и доменов SES

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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 в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

aws_ca_bundle

путь

Путь к пакету сертификатов ЦС для проверки 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 для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и вывода набора в ключ 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

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

feedback_forwarding

логическое значение

Указывает, следует ли включить пересылку обратной связи.

Значение может быть равно false, только если для параметров bounce_notifications и complaint_notifications заданы темы SNS.

Варианты:

  • false
  • true ← (по умолчанию)

identity

строка / обязательный

Адрес электронной почты или домен для проверки или удаления.

Если значение содержит символ «@», оно считается адресом электронной почты. В противном случае оно считается доменом.

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.

region

псевдонимы: aws_region

строка

Регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации 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 в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.

session_token

псевдонимы: aws_session_token

строка

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

строка

Создать (или обновить) идентификатор либо удалить его.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

validate_certs

логическое значение

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: При выполнении модулей переменные окружения и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать настройки учетных данных и другие значения по умолчанию, например регион, из файлов конфигурации в контексте «хоста» 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/ses_identity_module.html

Spec-Zone.ru

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