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 | |
| debug_botocore_endpoint_logs логическое добавлен в 2.8 |
| Использование логгера botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводящего набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения сценария. |
| ec2_url строка | URL для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. | |
| error_key - | Имя ключа объекта, используемого при возникновении ошибки 4XX класса. Для удаления ключа ошибки установите в None. | |
| name - / обязательно | Имя s3-бакета | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| redirect_all_requests - | Описание поведения переадресации для каждого запроса к веб-конечной точке s3-бакета | |
| region строка | AWS-регион для создания веба. Если не задан, проверяются переменные окружения AWS_REGION и EC2_REGION, затем настройки aws_region и ec2_region в файле конфигурации Boto. Если ни одна из них не задана, по умолчанию используется регион S3: стандартный США. псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS-токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - |
| Добавление или удаление конфигурации веб-страницы s3 |
| suffix - | По умолчанию: "index.html" | Суффикс, добавляемый к запросу, предназначенному для каталога на веб-конечной точке (например, если суффикс index.html, и вы делаете запрос samplebucket/images/, возвращаемые данные будут для объекта с именем ключа images/index.html). Суффикс не должен содержать символ косой черты. |
| validate_certs логическое |
| При значении "нет", сертификаты 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 строка | при установленном параметре redirect all requests | имя хоста, куда будут перенаправлены запросы. Пример: 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.8/modules/s3_website_module.html
