Spec-Zone.ru › Ansible 2.6

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)
    Варианты:
  • glacier ←
  • onezone_ia
  • standard_ia
Переводить неактуальные версии в этот класс хранения.
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
bool

(добавлено в 2.6)
    Варианты:
  • нет
  • да ←
Заменить ли все существующие переходы новыми. Если false, заданные переходы будут добавлены, заменяя переходы с тем же storage_class. Если 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
    Варианты:
  • present ←
  • absent
Создать или удалить правило жизненного цикла.
status
    Варианты:
  • enabled ←
  • disabled
Если 'enabled', правило в настоящее время применяется. Если 'disabled', правило в настоящее время не применяется.
storage_class
    Варианты:
  • glacier ←
  • onezone_ia
  • standard_ia
Класс хранилища, на который нужно перейти. В настоящее время поддерживаются два значения: '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
bool

(добавлено в 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

# 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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются партнёром 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.6/modules/s3_lifecycle_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API