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

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.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 путь	Путь к пакету сертификатов 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` для анализа уникальных (а не общего количества) вызовов 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`.
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 и session_token.
redirect_all_requests строка	Описывает поведение перенаправления для всех запросов к конечной точке веб-сайта этого S3-бакета.
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 строка / обязательный	Добавить или удалить конфигурацию веб-сайта S3 Варианты: `"present"` `"absent"`
suffix строка	Суффикс, добавляемый к запросу каталога на конечной точке веб-сайта (например, если суффикс — index.html и вы отправляете запрос к samplebucket/images/, возвращаются данные объекта с именем ключа images/index.html). Суффикс не должен содержать символ косой черты. По умолчанию: `"index.html"`
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.

Примеры

# 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 составной тип	Документ ошибки Возвращается: всегда
key строка	Имя ключа объекта, используемое при возникновении ошибки класса 4XX Возвращается: если задан параметр error_document Пример: `"error.html"`
index_document составной тип	Индексный документ Возвращается: всегда
suffix строка	Суффикс, добавляемый к запросу каталога на конечной точке веб-сайта Возвращается: при успешном выполнении Пример: `"index.html"`
redirect_all_requests_to составной тип	Место перенаправления запросов Возвращается: всегда
host_name строка	Имя хоста, на который будут перенаправляться запросы. Возвращается: если задан параметр перенаправления всех запросов Пример: `"ansible.com"`
protocol строка	Протокол, используемый при перенаправлении запросов. Возвращается: если задан параметр перенаправления всех запросов Пример: `"https"`
routing_rules список / элементы=строка	Правила маршрутизации Возвращается: всегда
condition составной тип	Контейнер с описанием условия, которое должно быть выполнено для применения указанного перенаправления. Возвращается: при успешном выполнении
http_error_code_returned_equals строка	Код ошибки HTTP при применении перенаправления. Возвращается: всегда
key_prefix_equals строка	Префикс имени ключа объекта при применении перенаправления. Например, для перенаправления запросов к ExamplePage.html префиксом ключа будет ExamplePage.html Возвращается: если задано правило маршрутизации Пример: `"docs/"`
redirect составной тип	Контейнер со сведениями о перенаправлении. Возвращается: всегда
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/s3_website_module.html