s3_website — Настройка веба для s3-бакета

Новая в версии 2.2.

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	Значение по умолчанию: None	Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url	Значение по умолчанию: None	URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая существует.
error_key	Значение по умолчанию: None	Имя ключа объекта для использования при ошибках 4XX. Для удаления ключа ошибки установите значение None.
name обязательно	Значение по умолчанию: None	Имя s3-бакета
profile (добавлено в 1.6)	Значение по умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
redirect_all_requests	Значение по умолчанию: None	Описывает поведение перенаправления для каждого запроса на конечную точку веб-сайта этого s3-бакета.
region	Значение по умолчанию: None	AWS регион для создания веба. Если не задан, проверяются значения AWS_REGION и EC2_REGION переменных окружения, затем параметры aws_region и ec2_region в файле конфигурации Boto. Если ни одно из этих значений не задано, регион по умолчанию — стандартный S3 регион США. Псевдонимы: aws_region, ec2_region
security_token (добавлено в 1.6)	Значение по умолчанию: None	AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	Варианты: present ← absent	Добавить или удалить конфигурацию веб-сайта s3
suffix	Значение по умолчанию: index.html	Приставка, добавляемая к запросу, для каталогов на веб-концевой точке (например, если приставка index.html, и вы делаете запрос samplebucket/images/, возвращаемые данные будут для объекта с именем ключа images/index.html). Приставка не должна содержать символ слеша.
validate_certs (добавлено в 1.5)	Варианты: no yes ←	При значении "no", сертификаты SSL не будут проверены для boto версий >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, 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
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не указаны. См. http://boto.readthedocs.org/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.

# Configure an s3 bucket to redirect all requests to example.com
- s3_website:
    name: mybucket.com
    redirect_all_requests: example.com
    state: present

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

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

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
error_document сложный		всегда	документ ошибки
	key строка	при установленном параметре error_document	имя ключа объекта, используемого при ошибках 4XX Пример: error.html
index_document сложный		всегда	документ по умолчанию
	suffix строка	при успехе	приставка, добавляемая к запросу для каталогов на веб-концевой точке Пример: index.html
redirect_all_requests_to сложный		всегда	куда перенаправляются запросы
	host_name строка	при установленном параметре redirect all requests	имя хоста, куда будут перенаправлены запросы. Пример: ansible.com
routing_rules сложный		всегда	правила маршрутизации
	redirect
	routing_rule
	condition строка	при наличии правила маршрутизации	префикс имени ключа объекта, когда применяется перенаправление. Например, для перенаправления запросов на ExamplePage.html префикс ключа будет ExamplePage.html Пример: docs/

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

Rob White (@wimnat)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/s3_website_module.html