s3_lifecycle – Управление правилами жизненного цикла ведра s3 в AWS
Новая версия 2.0.
Описание
- Управление правилами жизненного цикла ведер 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 | |
| ec2_url - | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. | |
| expiration_date - | Указывает срок действия объектов, на которые распространяется правило, по дате истечения срока действия. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть GMT. | |
| 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 - добавлено в 1.6 | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| purge_transitions boolean добавлено в 2.6 |
| Указывает, нужно ли заменить все текущие действия перевода новыми. Если значение false, указанные действия перевода будут добавлены, заменяя действия перевода с тем же классом хранения. Если значение true, существующие действия перевода будут удалены и заменены новыми. |
| 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 - добавлено в 1.6 | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state - |
| Создать или удалить правило жизненного цикла |
| status - |
| Если 'enabled', правило в настоящее время применяется. Если 'disabled', правило в настоящее время не применяется. |
| storage_class - |
| Класс хранения для перевода. В настоящее время поддерживаются два значения: 'glacier', 'onezone_ia' или 'standard_ia'. Класс 'standard_ia' доступен только начиная с версии Ansible 2.2. |
| transition_date - | Указывает срок действия объектов, на которые распространяется правило, по дате перехода в другой класс хранения. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть GMT. Если transition_days не указан, этот параметр требуется." | |
| transition_days - | Указывает, через сколько дней объект переходит в другой класс хранения. Если transition_date не указан, этот параметр требуется. | |
| transitions - добавлено в 2.6 | Список действий перевода для применения к правилу. Каждый класс хранения может быть использован только один раз. Каждое действие перевода может содержать элементы transition_days transition_date storage_class
| |
| validate_certs boolean добавлено в 1.5 |
| При значении "нет", сертификаты 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. [certified]
Авторы
- 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_lifecycle_module.html