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

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

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key -		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key -		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url -		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
error_key -		Имя объекта ключа, используемого при возникновении ошибки класса 4XX. Для удаления ключа ошибки установите значение None.
name - / обязательно		Имя s3-ведра
profile - добавлен в 1.6		Использует профиль boto. Работает только с boto >= 2.24.0.
redirect_all_requests -		Описывает поведение перенаправления для каждого запроса к этому веб-сайту конечной точки s3-ведра
region -		AWS-регион для создания ведра. Если не задан, проверяются значения переменных окружения AWS_REGION и EC2_REGION, затем параметры aws_region и ec2_region в файле конфигурации Boto. Если ни один из этих параметров не задан, регион по умолчанию — S3 Location: US Standard. Псевдонимы: aws_region, ec2_region
security_token - добавлен в 1.6		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 boolean добавлен в 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), если учетные данные не предоставлены. См. 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.

# 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 строка	при установленном параметре перенаправления всех запросов	имя хоста, куда будут перенаправлены запросы. Пример: ansible.com
routing_rules сложный		всегда	правила маршрутизации
	condition строка	при наличии правила маршрутизации	префикс имени ключа объекта, когда применяется перенаправление. Например, для перенаправления запросов на ExamplePage.html префикс ключа будет ExamplePage.html Пример: docs/
	redirect -
	routing_rule -

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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