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

Примечание

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

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

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

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

Новое в community.aws 1.0.0

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

Описание

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

Требования

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

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.
caller_reference строка	Уникальный идентификатор для ссылки на идентификатор доступа к источнику.
comment строка	Комментарий для описания идентификатора доступа к источнику CloudFront.
debug_botocore_endpoint_logs логический	Использование `botocore.endpoint` логгера для анализа уникальных (а не всех) `"resource:action"` API-вызовов во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода полного списка, созданного во время выполнения playbook. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
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.
origin_access_identity_id строка	origin_access_identity_id распределения CloudFront.
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 и security_token.
region псевдонимы: aws_region, ec2_region строка	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 псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним 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 строка	Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token 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 строка	Указывает, должно ли именованное ресурс существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs булево	При значении `false`, сертификаты SSL для связи с API AWS не будут проверены. Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

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