Manage S3 rules using the CLI

This page describes how to manage information lifecycle (ILM) rules for S3 buckets using the CLI.

Using the CLI, you can:

• Create an ILM rule

• View ILM rules

• Delete an ILM rule

• Reset ILM rules of a bucket

Create an ILM rule

Command: weka s3 bucket lifecycle-rule add

Use the following command line to create an ILM rule:

weka s3 bucket lifecycle-rule add <bucket> <expiry-days> [--prefix prefix] [--tags tags]

Parameters

Name	Type	Value	Limitations	Mandatory	Default
bucket	String	The name of the S3 bucket		Yes
expiry-days	Number	The number of days to wait before expiring an object	Minimum of 1 day	Yes
prefix	String	The prefix of objects to apply the rule to		No
tags	String	Key value pair of object tags to apply the rule to	Pairs of key values: '<k1>=<v1>&<k2=<v2>'	No

Note: The expiry-days is the minimum time to wait before expiring an object. In extreme load and scale cases, it might take longer than expiry-days to delete an object.

View ILM rules

Command: weka s3 bucket lifecycle-rule list‌

Use the following command line to view a bucket's existing ILM rules:‌

weka s3 bucket lifecycle-rule list <bucket>‌

Parameters

Name	Type	Value	Limitations	Mandatory	Default
bucket	String	The name of the S3 bucket	​Content	Yes	​Content

Delete an ILM rule

Command: weka s3 bucket lifecycle-rule remove

Use the following command line to delete an ILM rule:

weka s3 bucket lifecycle-rule remove <bucket> <rule>

Parameters

Name	Type	Value	Limitations	Mandatory	Default
bucket	String	The name of the S3 bucket		Yes
rule	String	The ID of the rule to delete		Yes

Reset ILM rules of a bucket

Command: weka s3 bucket lifecycle-rule reset

Use the following command line to delete all the ILM rules of a specified bucket:

weka s3 bucket lifecycle-rule reset <bucket>

Parameters

Name	Type	Value	Limitations	Mandatory	Default
bucket	String	The name of the S3 bucket		Yes