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

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/s3_website_module.html