s3_lifecycle – Управление правилами жизненного цикла ведра s3 в AWS
Обзор
- Управление правилами жизненного цикла ведра s3 в AWS
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- python >= 2.6
- python-dateutil
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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-вызовов «ресурс:действие», выполняемых во время задачи, выводя набор в ключ task results. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая существует. | |
| expiration_date - | Указывает срок службы объектов, которые подчиняются правилу, по дате истечения срока действия. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть указан по Гринвичу. | |
| expiration_days - | Указывает срок службы объектов, которые подчиняются правилу, в днях. Значение должно быть положительным целым числом, отличным от нуля. | |
| name - / обязательно | Имя ведра s3 | |
| noncurrent_version_expiration_days - добавлено в 2.6 | Удалить неактуальные версии через столько дней после того, как они станут неактуальными | |
| noncurrent_version_storage_class - добавлено в 2.6 |
| Перевести неактуальные версии в этот класс хранилища |
| noncurrent_version_transition_days - добавлено в 2.6 | Перевести неактуальные версии через столько дней после того, как они станут неактуальными | |
| noncurrent_version_transitions - добавлено в 2.6 | Список правил перехода, которые должны применяться к неактуальным версиям для правила. Каждый класс хранилища может использоваться только один раз. Каждое правило перехода содержит следующие элементы: transition_days storage_class
| |
| prefix - | Префикс, определяющий один или несколько объектов, на которые распространяется правило. Если префикс не указан, правило будет применено ко всему ведру. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| purge_transitions логический тип добавлено в 2.6 |
| «Заменять ли все текущие переходы новыми переходами. Если ложь, предоставленные переходы будут добавлены, заменяя переходы с тем же storage_class. Если истина, существующие переходы будут удалены и заменены новыми переходами» |
| region строка | Регион AWS, который следует использовать. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| rule_id - | Уникальный идентификатор правила. Значение не может быть длиннее 255 символов. Если значение не предоставлено, будет сгенерировано уникальное значение для правила. | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - |
| Создать или удалить правило жизненного цикла |
| status - |
| Если «активный», правило в настоящее время применяется. Если «отключен», правило в настоящее время не применяется. |
| storage_class - |
| Класс хранилища, в который необходимо перейти. В настоящее время поддерживаются два значения — «glacier», «onezone_ia» или «standard_ia». Класс «standard_ia» доступен только с версии Ansible 2.2. |
| transition_date - | Указывает срок службы объектов, которые подчиняются правилу, по дате, когда они перейдут в другой класс хранилища. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть указан по Гринвичу. Если transition_days не указан, этот параметр требуется. | |
| transition_days - | Указывает, через сколько дней объект переходит в другой класс хранилища. Если transition_date не указан, этот параметр требуется. | |
| transitions - добавлено в 2.6 | Список правил перехода, которые должны применяться к правилу. Каждый класс хранилища может использоваться только один раз. Каждое правило перехода может содержать следующие элементы: transition_days transition_date storage_class
| |
| 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 a lifecycle rule on a bucket to expire (delete) items with a prefix of /logs/ after 30 days
- s3_lifecycle:
name: mybucket
expiration_days: 30
prefix: /logs/
status: enabled
state: present
# Configure a lifecycle rule to transition all items with a prefix of /logs/ to glacier after 7 days and then delete after 90 days
- s3_lifecycle:
name: mybucket
transition_days: 7
expiration_days: 90
prefix: /logs/
status: enabled
state: present
# Configure a lifecycle rule to transition all items with a prefix of /logs/ to glacier on 31 Dec 2020 and then delete on 31 Dec 2030.
# Note that midnight GMT must be specified.
# Be sure to quote your date strings
- s3_lifecycle:
name: mybucket
transition_date: "2020-12-30T00:00:00.000Z"
expiration_date: "2030-12-30T00:00:00.000Z"
prefix: /logs/
status: enabled
state: present
# Disable the rule created above
- s3_lifecycle:
name: mybucket
prefix: /logs/
status: disabled
state: present
# Delete the lifecycle rule created above
- s3_lifecycle:
name: mybucket
prefix: /logs/
state: absent
# Configure a lifecycle rule to transition all backup files older than 31 days in /backups/ to standard infrequent access class.
- s3_lifecycle:
name: mybucket
prefix: /backups/
storage_class: standard_ia
transition_days: 31
state: present
status: enabled
# Configure a lifecycle rule to transition files to infrequent access after 30 days and glacier after 90
- s3_lifecycle:
name: mybucket
prefix: /logs/
state: present
status: enabled
transitions:
- transition_days: 30
storage_class: standard_ia
- transition_days: 90
storage_class: glacier
Статус
- В этом модуле гарантируются изменения интерфейса, совместимые с предыдущими версиями. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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_lifecycle_module.html