s3_lifecycle - Управление правилами жизненного цикла ведра s3 в AWS

Новая версия с 2.0.

Обзор
- Требования
Параметры
Примечания
Примеры
Статус
- Автор

Обзор

Управление правилами жизненного цикла ведра s3 в AWS

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

boto
python >= 2.6
python-dateutil

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key	Значение по умолчанию: None	Ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
ec2_url	Значение по умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
expiration_date	Значение по умолчанию: None	Указывает срок хранения объектов, подпадающих под правило, по дате истечения срока действия. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть GMT.
expiration_days	Значение по умолчанию: None	Указывает срок хранения объектов, подпадающих под правило, в днях. Значение должно быть положительным целым числом, отличным от нуля.
name обязательно		Имя ведра s3
prefix	Значение по умолчанию: None	Префикс, определяющий один или несколько объектов, к которым применяется правило. Если префикс не указан, правило будет применяться ко всему ведру.
profile (добавлен в 1.6)	Значение по умолчанию: None	Использует профиль 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	Значение по умолчанию: None	Уникальный идентификатор правила. Значение не может быть длиннее 255 символов. Уникальное значение для правила будет сгенерировано, если оно не указано.
security_token (добавлен в 1.6)	Значение по умолчанию: None	Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state	Варианты: present ← absent	Создание или удаление правила жизненного цикла
status	Варианты: enabled ← disabled	Если 'enabled', правило в настоящее время применяется. Если 'disabled', правило в настоящее время не применяется.
storage_class	Варианты: glacier ← standard_ia	Класс хранения, на который необходимо перейти. В настоящее время поддерживаются два значения — 'glacier' или 'standard_ia'. Класс 'standard_ia' доступен только начиная с версии Ansible 2.2.
transition_date	Значение по умолчанию: None	Указывает срок хранения объектов, подпадающих под правило, по дате перехода в другой класс хранения. Значение должно быть в формате ISO-8601, время должно быть полночь, а часовой пояс должен быть GMT. Если transition_days не указан, этот параметр обязателен.
transition_days	Значение по умолчанию: None	Указывает, в какой день объект переходит в другой класс хранения. Если transition_date не указан, этот параметр обязателен.
validate_certs (добавлен в 1.5)	Варианты: no yes ←	При установке в "no", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься обратные несовместимые изменения в интерфейс.

Автор

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.5/modules/s3_lifecycle_module.html