docs/source/reference/minio-mc/mc-ilm-rule-edit.rst

mc ilm rule edit

minio

Table of Contents

mc ilm rule edit

RELEASE.2022-12-24T15-21-38Z

mc ilm rule edit replaces mc ilm edit.

Syntax

The mc ilm rule edit command modifies an existing object lifecycle management rule on a MinIO bucket.

EXAMPLE

The following command modifies existing lifecycle management rules for the mydata bucket on the myminio deployment:

mc ilm rule edit --id "c79ntj94b0t6rukh6lr0" --expiry-days 90  myminio/mydata

mc ilm rule edit --id "c79nu2p4b0t6qko19rgg" --expired-object-delete-marker myminio/mydata

mc ilm rule edit --id "c79n19dn10dnab109fg1" --transition-days 30 --tier "COLDTIER"

The command modifies the specified rules as follows:

• Delete objects more than 90 days old.
• Delete DeleteMarker tombstones if that object has no other versions remaining.
• Transition objects more than 30 days old to the COLDTIER remote tier.

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] ilm rule edit                                       \
                 --id "string"                                       \
                 [--prefix "string"]                                 \
                 [--enable]                                          \
                 [--disable]                                         \
                 [--expire-days "string"]                            \ 
                 [--expire-delete-marker]                            \
                 [--transition-days "string"]                        \
                 [--transition-tier "string"]                        \
                 [--noncurrent-expire-days "string"]                 \
                 [--noncurrent-expire-newer "string"]                \
                 [--noncurrent-transition-days "string"]             \
                 [--noncurrent-transition-tier "string"]             \
                 [--tags]                                            \
                 ALIAS

Parameters

ALIAS

The alias <alias> and full path to the bucket on the MinIO deployment to which to modify the object lifecycle management rule. For example:

mc ilm rule edit myminio/mydata

--id

The unique ID of the rule. Use mc ilm rule ls to list bucket rules and retrieve the id for the rule you want to modify.

--disable

Stop using the rule, but retain the rule for future use. Objects do not transition or expire when a rule is disabled.

--enable

Use a rule to transition or expire objects.

--prefix

Restrict the management rule to a specific bucket prefix.

For example:

mc ilm rule edit --prefix "meetingnotes/" myminio/mydata --expire-days "90"

The command modifies a rule that expires objects in the mydata bucket of the myminio ALIAS after 90 days for any object with the meetingnotes/ prefix.

--expire-days

The number of days to retain an object after being created. MinIO marks the object for deletion after the specified number of days pass.

Exercise caution when using this option, as its behavior can result in immediate expiration of uploaded objects. Any objects created after the specified expiration date are automatically eligible for expiration. Similarly, specifying a calendar date that is prior to the current system host datetime marks all objects covered by the rule for deletion. Consider immediately removing any ILM rule using this option once the specified calendar date has passed.

For versioned buckets, the expiry rule applies only to the current object version. Use the ~mc ilm rule edit --noncurrent-expire-days option to apply expiration behavior to noncurrent object versions.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See minio-lifecycle-management-scanner for more information.

Mutually exclusive with the following options:

• ~mc ilm rule edit --expire-delete-marker

--expire-delete-marker

Specify this option to direct MinIO to remove delete markers for objects with no remaining object versions. Specifically, the delete marker is the only remaining "version" of the given object.

This option is mutually exclusive with the following options:

• ~mc ilm rule edit --tags
• ~mc ilm rule edit --expire-days

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See minio-lifecycle-management-scanner for more information.

--noncurrent-expire-days

The number of days to retain an object version after becoming non-current (i.e. a different version of that object is now the HEAD). MinIO marks noncurrent object versions for deletion after the specified number of days pass.

This option has the same behavior as the S3 NoncurrentVersionExpiration action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See minio-lifecycle-management-scanner for more information.

--noncurrent-expire-newer

The number of non-current versions of an object to retain before applying expiration. Older non-current versions beyond the specified number expire.

By default, MinIO does not retain any non-current versions when an expiration rule applies.

--noncurrent-transition-days

The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition. MinIO transitions the object to the configured remote storage tier specified to the ~mc ilm rule edit --transition-tier once the system host datetime passes that calendar date.

This option has no effect on non-versioned buckets. Requires specifying ~mc ilm rule edit --noncurrent-transition-tier.

This option has the same behavior as the S3 NoncurrentVersionTransition action.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See minio-lifecycle-management-scanner for more information.

--noncurrent-transition-tier

The remote storage tier to which MinIO transitions noncurrent objects versions <minio-lifecycle-management-tiering>. Specify a remote storage tier created by mc ilm tier add.

MinIO does not automatically migrate objects from the previously specified remote tier to the new remote tier. MinIO continues to route requests for objects stored on the old remote tier.

--tags

One or more ampersand &-delimited key-value pairs describing the object tags to which to apply the lifecycle configuration rule.

This option is mutually exclusive with the following option:

• ~mc ilm rule edit --expire-delete-marker

--transition-days

The number of calendar days from object creation after which MinIO marks an object as eligible for transition. MinIO transitions the object to the configured remote storage tier specified to the ~mc ilm rule edit --transition-tier.

For versioned buckets, the transition rule applies only to the current object version. Use the ~mc ilm rule edit --noncurrent-transition-days option to apply transition behavior to noncurrent object versions.

Requires specifying ~mc ilm rule edit --transition-tier.

MinIO uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See minio-lifecycle-management-scanner for more information.

--transition-tier

The remote storage tier to which MinIO transition objects <minio-lifecycle-management-tiering>. Specify a remote storage tier created by mc ilm tier add.

Required if specifying ~mc ilm rule edit --transition-days.

MinIO does not automatically migrate objects from the previously specified remote tier to the new remote tier. MinIO continues to route requests for objects stored on the old remote tier.

Global Flags

Examples

Modify an Existing Lifecycle Management Rule

Use mc ilm rule edit with ~mc ilm rule edit --id to modify an existing object expiration rule:

mc ilm rule edit ALIAS/PATH --id "RULEID" [FLAGS]

• Replace ALIAS <mc ilm rule edit ALIAS> with the alias <mc alias> of the S3-compatible host.
• Replace PATH <mc ilm rule edit ALIAS> with the path to the bucket on the S3-compatible host.
• Replace RULEID with the unique ID of the object lifecycle management rule. Use mc ilm rule ls to find the RULEID.
• Specify any additional flags to add or modify the lifecycle management rule. For example, specify ~mc ilm rule edit --transition-days to override the existing transition days value for the rule.

Disable a Lifecycle Management Rule

Use mc ilm rule edit with ~mc ilm rule edit --disable to stop using an existing management rule.

mc ilm rule edit --id "RULEID" --disable myminio/mybucket

• Replace RULEID with the unique ID of the object lifecycle management rule. Use mc ilm rule ls to find the RULEID.
• Replace myminio with the ALIAS of the deployment where the rule exists.
• Replace mybucket with the bucket for the rule.

Required Permissions

For permissions required to edit a rule, refer to the required permissions <minio-mc-ilm-rule-permissions> on the parent command.

Behavior

S3 Compatibility