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 | ||
| prefix | нет | Префикс, определяющий один или несколько объектов, на которые распространяется правило. Если префикс не указан, правило будет применяться ко всему ведру. | ||
| profile (добавлено в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| 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 | нет | present |
| Создать или удалить правило жизненного цикла |
| status | нет | enabled |
| Если 'enabled', правило в настоящее время применяется. Если 'disabled', правило в настоящее время не применяется. |
| storage_class | нет | glacier |
| Класс хранения, на который будет произведено переключение. В настоящее время поддерживаются два значения — 'glacier' или 'standard_ia'. Класс 'standard_ia' доступен только начиная с версии Ansible 2.2. |
| transition_date | нет | Указывает срок действия объектов, которые подпадают под действие правила, по дате перехода в другой класс хранения. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть GMT. Если transition_days не указан, этот параметр требуется." | ||
| transition_days | нет | Указывает, через сколько дней объект перейдет в другой класс хранения. Если transition_date не указан, этот параметр требуется. | ||
| validate_certs (добавлено в 1.5)
| нет | да |
| Если установлено "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены. |
Примеры
# 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
Примечания
Примечание
- Если срок действия указывается в днях, то время перехода также должно быть указано в днях
- Если срок действия указывается как дата, то время перехода также должно быть указано как дата
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будет внесено обратной совместимости.
Для получения помощи в разработке модулей, если вы так склонны, пожалуйста, прочитайте Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/s3_lifecycle_module.html