Модуль community.aws.s3_website — Настройка веба в s3-бакете

Примечание

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

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

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

Для использования в плейбуке укажите: community.aws.s3_website.

Добавлена в community.aws 1.0.0

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

Обзор

Настройка веба в s3-бакете

Требования

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

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.
debug_botocore_endpoint_logs логический тип	Используйте `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, выполненных во время задачи, выводите набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода в общий список, сделанный во время выполнения книги. Также может использоваться переменная среды `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.
error_key строка	Имя ключа объекта, используемое при возникновении ошибки класса 4XX. Для удаления ключа ошибки установите значение None.
name строка / обязательно	Имя ведра s3
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.
redirect_all_requests строка	Описывает поведение перенаправления для каждого запроса на конечную точку сайта ведра s3
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 string	Токен сеанса 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 string / обязательный	Добавление или удаление конфигурации веб-сайта S3 Варианты: `"present"` `"absent"`
suffix string	Суффикс, добавляемый к запросу к каталогу на веб-узле (например, если суффикс index.html, а вы делаете запрос к samplebucket/images/, то возвращаемые данные будут для объекта с именем ключа images/index.html). Суффикс не должен содержать символа слэша. По умолчанию: `"index.html"`
validate_certs boolean	При установке в `false`, сертификаты SSL не будут проверяться при общении с API AWS. Установку validate_certs=false настоятельно не рекомендуется, как альтернативу, рассмотрите установку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста хоста Ansible, а не из контекста контроллера. Поэтому файлы, возможно, необходимо явно скопировать на хост. Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста контроллера Ansible, а не из контекста хоста.
AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте хоста 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: Configure an s3 bucket to redirect all requests to example.com
  community.aws.s3_website:
    name: mybucket.com
    redirect_all_requests: example.com
    state: present

- name: Remove website configuration from an s3 bucket
  community.aws.s3_website:
    name: mybucket.com
    state: absent

- name: Configure an s3 bucket as a website with index and error pages
  community.aws.s3_website:
    name: mybucket.com
    suffix: home.htm
    error_key: errors/404.htm
    state: present

Значения возврата

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

Ключ	Описание
error_document complex	документ ошибки Возвращается: всегда
key строка	имя ключа объекта для использования при возникновении ошибки класса 4XX Возвращается: при установке параметра error_document Пример: `"error.html"`
index_document complex	документ индекса Возвращается: всегда
suffix строка	суффикс, добавляемый к запросу, который предназначен для каталога на веб-узле конечной точки Возвращается: успешно Пример: `"index.html"`
redirect_all_requests_to complex	куда перенаправить запросы Возвращается: всегда
host_name строка	имя хоста, куда будут перенаправлены запросы. Возвращается: при установке параметра перенаправления всех запросов Пример: `"ansible.com"`
protocol строка	протокол для использования при перенаправлении запросов. Возвращается: при установке параметра перенаправления всех запросов Пример: `"https"`
routing_rules список / элементы=строка	правила маршрутизации Возвращается: всегда
condition complex	Контейнер для описания условия, которое должно быть выполнено для применения указанного перенаправления. Возвращается: успешно
http_error_code_returned_equals строка	Код HTTP-ошибки, когда применяется перенаправление. Возвращается: всегда
key_prefix_equals строка	Префикс имени ключа объекта при применении перенаправления. Например, для перенаправления запросов на ExamplePage.html префикс ключа будет ExamplePage.html Возвращается: при наличии правила маршрутизации Пример: `"docs/"`
redirect complex	Контейнер для информации о перенаправлении. Возвращается: всегда
host_name строка	имя хоста, куда будут перенаправлены запросы. Возвращается: при установке имени хоста в рамках правила перенаправления Пример: `"ansible.com"`
http_redirect_code строка	Код HTTP-перенаправления, используемый в ответе. Возвращается: при наличии правила маршрутизации
protocol строка	Протокол, используемый при перенаправлении запросов. Возвращается: при наличии правила маршрутизации Пример: `"http"`
replace_key_prefix_with строка	префикс ключа объекта для использования в запросе перенаправления Возвращается: при наличии правила маршрутизации Пример: `"documents/"`
replace_key_with строка	префикс ключа объекта для использования в запросе перенаправления Возвращается: при наличии правила маршрутизации Пример: `"documents/"`

Авторы

Rob White (@wimnat)

Ссылки на коллекции

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