Spec-Zone.ru › Ansible 2.11

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 Bundle) для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: CA Bundle считывается со стороны модуля и может потребоваться явное копирование его с контроллера, если модуль не выполняется локально.
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 для вывода полного списка, выполненного во время исполнения playbook. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
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
булево
    Варианты:
  • нет
  • да ←
Включить или выключить обратную связь (feedback forwarding).
Это может быть только false, если и 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 станут взаимоисключающими с profile после 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
строка
    Варианты:
  • present ←
  • absent
Создать/обновить или удалить идентификатор.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_ses_identity_module.html

Spec-Zone.ru

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