Beginning with ONTAP 9.13.1, you can create lifecycle management rules to manage object lifecycles in your S3 buckets. You can define deletion rules for specific objects in a bucket, and through these rules, expire those bucket objects. This enables you to meet retention requirements and manage overall S3 object storage efficiently.

If object locking is enabled for your bucket objects, the lifecycle management rules for object expiration will not be applied on locked objects. For information about object locking, see Create a bucket.

Before you begin

An S3-enabled SVM containing an S3 server and a bucket must already exist. See Create an SVM for S3 for more information.

About this task

When creating your lifecycle management rules, you can apply the following deletion actions to your bucket objects:

Deletion of current versions - This action expires objects identified by the rule. If versioning is enabled on the bucket, S3 makes all expired objects unavailable. If versioning is not enabled, this rule deletes the objects permanently. The CLI action is Expiration.
Deletion of non-current versions - This action specifies when S3 can permanently remove non-current objects. The CLI action is NoncurrentVersionExpiration.
Deletion of expired delete markers - This action deletes expired object delete markers. In versioning-enabled buckets, objects with a delete markers become the current versions of the objects. The objects are not deleted, and no action can be performed on them. These objects become expired when there are no current versions associated with them. The CLI action is Expiration.
Deletion of incomplete multipart uploads - This action sets a maximum time (in days) that you want to allow multipart uploads to remain in progress. Following which, they are deleted. The CLI action is AbortIncompleteMultipartUpload.

The procedure you follow depends on the interface that you use. With ONTAP 9.13,1, you need to use the CLI.

Manage lifecycle management rules with the CLI

Beginning with ONTAP 9.13.1, you can use the ONTAP CLI to create lifecycle management rules to expire objects in your S3 buckets.

What you’ll need

For the CLI, you need to define the required fields for each expiration action type when creating a bucket lifecycle management rule. These fields can be modified after initial creation. The following table displays the unique fields for each action type.

Action type	Unique fields
NonCurrentVersionExpiration	`-non-curr-days` - Number of days after which non-current versions will be deleted `-new-non-curr-versions` - Number of latest non-current versions to be retained
Expiration	`-obj-age-days` - Number of days since creation, after which current version of objects can be deleted `-obj-exp-date` - Specific date when the objects should expire `-expired-obj-del-markers` - Cleanup object delete markers
AbortIncompleteMultipartUpload	`-after-initiation-days` - Number of days of initiation, after which upload can be aborted

Action type

Unique fields

NonCurrentVersionExpiration

-non-curr-days - Number of days after which non-current versions will be deleted
-new-non-curr-versions - Number of latest non-current versions to be retained

Expiration

-obj-age-days - Number of days since creation, after which current version of objects can be deleted
-obj-exp-date - Specific date when the objects should expire
-expired-obj-del-markers - Cleanup object delete markers

AbortIncompleteMultipartUpload

-after-initiation-days - Number of days of initiation, after which upload can be aborted

In order for the bucket lifecycle management rule to only be applied to a specific subset of objects, admins must set each filter when creating the rule. If these filters are not set when creating the rule, the rule will be applied to all objects within the bucket.

All filters can be modified after initial creation except for the following:

-prefix
-tags
-obj-size-greater-than
-obj-size-less-than

Steps

Use the vserver object-store-server bucket lifecycle-management-rule create command with required fields for your expiration action type to create your bucket lifecycle management rule.

Example

The following command creates a NonCurrentVersionExpiration bucket lifecycle management rule:

vserver object-store-server bucket lifecycle-management-rule create -vserver <svm_name> -bucket <bucket_name> -rule-id <rule_name> -action NonCurrentVersionExpiration -index <lifecycle_rule_index_integer> -is-enabled {true|false} -prefix <object_name> -tags <text> -obj-size-greater-than {<integer>[KB|MB|GB|TB|PB]} -obj-size-less-than {<integer>[KB|MB|GB|TB|PB]} -new-non-curr-versions <integer> -non-curr-days <integer>

Example

The following command creates an Expiration bucket lifecycle management rule:

vserver object-store-server bucket lifecycle-management-rule create -vserver <svm_name> -bucket <bucket_name> -rule-id <rule_name> -action Expiration -index <lifecycle_rule_index_integer> -is-enabled {true|false} -prefix <object_name> -tags <text> -obj-size-greater-than {<integer>[KB|MB|GB|TB|PB]} -obj-size-less-than {<integer>[KB|MB|GB|TB|PB]} -obj-age-days <integer> -obj-exp-date <"MM/DD/YYYY HH:MM:SS"> -expired-obj-del-marker {true|false}

Example

The following command creates an AbortIncompleteMultipartUpload bucket lifecycle management rule:

vserver object-store-server bucket lifecycle-management-rule create -vserver <svm_name> -bucket <bucket_name> -rule-id <rule_name> -action AbortIncompleteMultipartUpload -index <lifecycle_rule_index_integer> -is-enabled {true|false} -prefix <object_name> -tags <text> -obj-size-greater-than {<integer>[KB|MB|GB|TB|PB]} -obj-size-less-than {<integer>[KB|MB|GB|TB|PB]} -after-initiation-days <integer>