s3_website – Настроить ведро s3 в качестве веб-сайта
Краткое описание
- Настроить ведро 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:action", сделанных во время задачи, выводе набора в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения плейбука. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| 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.9/modules/s3_website_module.html
