community.aws.s3_website – Настройка веба в s3-бакете

Примечание

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

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

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

Новое в версии 1.0.0: of community.aws

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

Обзор

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

Требования

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

boto
boto3
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 считывается на стороне модуля и может потребоваться явное копирование с контроллера, если модуль не запущен локально.
aws_config словарь		Словарь для изменения настроек botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительных настроек 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
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Использование логгера botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие», произведённых во время задачи, выводит набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, произведённого во время выполнения playbook. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или Eucalyptus облаку (по умолчанию модуль использует EC2 адреса). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. Псевдонимы: aws_endpoint_url, endpoint_url
error_key строка		Имя ключа объекта, используемого при возникновении ошибки класса 4XX. Для удаления ключа ошибки установите значение None.
name строка / требуется		Имя s3-бакета
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
redirect_all_requests строка		Описывает поведение перенаправления для каждого запроса к веб-точке входа s3-бакета
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	Добавить или удалить конфигурацию веб-сайта s3
suffix строка	Значение по умолчанию: "index.html"	Суффикс, добавляемый к запросу, для каталога на веб-точке входа (например, если суффикс index.html, и вы делаете запрос к samplebucket/images/, возвращаемые данные будут для объекта с именем ключа images/index.html). Суффикс не должен содержать символ слеша.
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

Примеры

# 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 строка		при установке параметра error_document	имя ключа объекта для использования при возникновении ошибки класса 4XX Пример: 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/s3_website_module.html