Spec-Zone.ru › Ansible

Модуль community.aws.s3_lifecycle – Управление правилами жизненного цикла ведер S3 в AWS

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook укажите: community.aws.s3_lifecycle.

Добавлена в community.aws 1.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

Описание

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

abort_incomplete_multipart_upload_days

integer

added in community.aws 2.2.0

Указывает количество дней с момента начала неполной многочастной загрузки, в течение которых Amazon S3 будет ждать, прежде чем окончательно удалить все части загрузки.

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа AWS.

Дополнительные сведения о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Также может использоваться переменная среды AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время playbook.

Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (default)
  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также могут использоваться переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

expiration_date

string

Указывает срок действия объектов, подпадающих под действие правила, по дате их истечения.

Значение должно быть в формате ISO-8601, время должно быть полночь, и должен быть указан часовой пояс GMT.

Это не может быть указано с expire_object_delete_marker

expiration_days

integer

Указывает срок действия, в днях, объектов, подпадающих под действие правила.

Значение должно быть положительным целым числом, отличным от нуля.

Это не может быть указано с expire_object_delete_marker

expire_object_delete_marker

boolean

added in community.aws 2.2.0

Указывает, будет ли Amazon S3 удалять маркер удаления без нетекущих версий.

Если установлено значение true, маркер удаления будет просрочен; если установлено значение false, политика не предпринимает никаких действий.

Это не может быть указано с expiration_days или expiration_date.

Варианты:

  • false
  • true

name

string / required

Название S3-бакета.

noncurrent_version_expiration_days

integer

Количество дней, по истечении которых следует удалять нетекущие версии.

Должно быть установлено, если установлен параметр noncurrent_version_keep_newer.

noncurrent_version_keep_newer

integer

added in community.aws 5.3.0

Минимальное количество нетекущих версий для сохранения.

Требуется noncurrent_version_expiration_days.

noncurrent_version_storage_class

string

Класс хранения, в который перемещаются нетекущие версии.

Варианты:

  • "glacier" ← (default)
  • "onezone_ia"
  • "standard_ia"
  • "intelligent_tiering"
  • "deep_archive"

noncurrent_version_transition_days

integer

Количество дней, по истечении которых нетекущие версии будут переведены в класс хранения, указанный в noncurrent_version_storage_class.

noncurrent_version_transitions

list / elements=dictionary

Список поведений перехода, которые будут применены к нетекущим версиям для правила.

Каждый класс хранения может использоваться только один раз. Каждое поведение перехода содержит следующие элементы: transition_days storage_class

prefix

string

Префикс, определяющий один или несколько объектов, к которым применяется правило.

Если префикс не указан, правило будет применяться ко всему ведру.

profile

aliases: aws_profile

string

Используемый профиль AWS для аутентификации.

Дополнительную информацию о профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token.

purge_transitions

boolean

Определяет, следует ли заменить все текущие переходы новыми.

Когда false, указанные переходы будут добавлены, заменяя переходы с тем же storage_class. При значении true, существующие переходы будут удалены и заменены новыми.

Варианты:

  • false
  • true ← (по умолчанию)

region

aliases: aws_region, ec2_region

string

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

rule_id

string

Уникальный идентификатор правила.

Значение не может быть длиннее 255 символов.

Если значение не указано, будет сгенерировано уникальное значение для правила.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Опции secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для соответствия AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Опции security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

string

Создать или удалить правило жизненного цикла.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

status

string

Если enabled, правило в данный момент применяется.

Если disabled, правило в данный момент не применяется.

Варианты:

  • "enabled" ← (по умолчанию)
  • "disabled"

storage_class

string

Класс хранения, на который нужно перейти.

Варианты:

  • "glacier" ← (по умолчанию)
  • "onezone_ia"
  • "standard_ia"
  • "intelligent_tiering"
  • "deep_archive"

transition_date

string

Указывает срок действия объектов, подпадающих под правило, по дате, когда они будут переведены в другой класс хранения.

Значение должно быть в формате ISO-8601, время должно быть полночь, и должен быть указан часовой пояс GMT.

Если (transition_days) не указан, этот параметр необходим.

transition_days

integer

Указывает, через сколько дней объект переводится в другой класс хранения.

Если transition_date не указан, этот параметр необходим.

transitions

list / elements=dictionary

Список поведений переходов, которые нужно применить к правилу.

Каждый класс хранения может быть использован только один раз. Каждое поведение перехода может содержать следующие элементы: transition_days, transition_date, storage_class

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false категорически не рекомендуется, в качестве альтернативы, установите aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

wait

boolean

добавлено в community.aws 1.5.0

Ожидать завершения конфигурации перед возвратом.

Варианты:

  • false ← (по умолчанию)
  • true

Примечания

Примечание

  • Если срок действия задается в днях, то время перехода также должно быть указано в днях.
  • Если срок действия задается как дата, то время перехода также должно быть указано как дата.
  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». В связи с этим файлы, возможно, потребуется скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Подробнее см. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Configure a lifecycle rule on a bucket to expire (delete) items with a prefix of /logs/ after 30 days
  community.aws.s3_lifecycle:
    name: mybucket
    expiration_days: 30
    prefix: logs/
    status: enabled
    state: present

- name: Configure a lifecycle rule to transition all items with a prefix of /logs/ to glacier after 7 days and then delete after 90 days
  community.aws.s3_lifecycle:
    name: mybucket
    transition_days: 7
    expiration_days: 90
    prefix: logs/
    status: enabled
    state: present

# Note that midnight GMT must be specified.
# Be sure to quote your date strings
- name: 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.
  community.aws.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

- name: Disable the rule created above
  community.aws.s3_lifecycle:
    name: mybucket
    prefix: logs/
    status: disabled
    state: present

- name: Delete the lifecycle rule created above
  community.aws.s3_lifecycle:
    name: mybucket
    prefix: logs/
    state: absent

- name: Configure a lifecycle rule to transition all backup files older than 31 days in /backups/ to standard infrequent access class.
  community.aws.s3_lifecycle:
    name: mybucket
    prefix: backups/
    storage_class: standard_ia
    transition_days: 31
    state: present
    status: enabled

- name: Configure a lifecycle rule to transition files to infrequent access after 30 days and glacier after 90
  community.aws.s3_lifecycle:
    name: mybucket
    prefix: logs/
    state: present
    status: enabled
    transitions:
      - transition_days: 30
        storage_class: standard_ia
      - transition_days: 90
        storage_class: glacier

Авторы

  • Rob White (@wimnat)

Ссылки на коллекции

  • Система отслеживания задач
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/s3_lifecycle_module.html

Spec-Zone.ru

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