community.aws.cloudfront_origin_access_identity – Создание, обновление и удаление идентификаторов доступа к источнику для распределения CloudFront

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

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

Новое в версии 1.0.0: коллекции community.aws

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

Обзор

Обеспечивает удобное создание, обновление и удаление идентификаторов доступа к источнику.

Требования

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

boto
boto3 >= 1.0.0
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 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
caller_reference строка		Уникальный идентификатор для ссылки на идентификатор доступа к источнику.
comment строка		Комментарий для описания идентификатора доступа к источнику CloudFront.
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Использование логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, вывода набора в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, сделанного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
origin_access_identity_id строка		origin_access_identity_id распределения CloudFront.
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

Примеры

- name: create an origin access identity
  community.aws.cloudfront_origin_access_identity:
    state: present
    caller_reference: this is an example reference
    comment: this is an example comment

- name: update an existing origin access identity using caller_reference as an identifier
  community.aws.cloudfront_origin_access_identity:
     origin_access_identity_id: E17DRN9XUOAHZX
     caller_reference: this is an example reference
     comment: this is a new comment

- name: delete an existing origin access identity using caller_reference as an identifier
  community.aws.cloudfront_origin_access_identity:
     state: absent
     caller_reference: this is an example reference
     comment: this is a new comment

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращается	Описание
cloud_front_origin_access_identity сложное			всегда	Информация об идентификаторе доступа к источнику.
	cloud_front_origin_access_identity_config сложное		всегда	Описывает URL, указывающий на идентификатор доступа к источнику.
		caller_reference строка	всегда	ссылка вызывающего объекта для oai
		comment строка	всегда	комментарий, описывающий oai
	id строка		всегда	уникальный идентификатор oai
	s3_canonical_user_id строка		всегда	канонический идентификатор пользователя, который создал oai
e_tag строка			всегда	Текущая версия созданного идентификатора доступа к источнику.
location строка			при первоначальном создании	Полный URI нового идентификатора доступа к источнику, который только что был создан.

Авторы

Willem van Ketwich (@wilvk)

© 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/cloudfront_origin_access_identity_module.html