Spec-Zone.ru › Ansible

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

Примечание

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

caller_reference

строка

Уникальный идентификатор для ссылки на идентификатор доступа к источнику.

comment

строка

Комментарий с описанием идентификатора доступа к источнику CloudFront.

debug_botocore_endpoint_logs

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

Использовать регистратор botocore.endpoint для анализа уникальных (а не общих) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных во время плейбука.

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

Варианты:

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

endpoint_url

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

строка

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

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

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 и 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.

Примеры

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

Spec-Zone.ru

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