Object Lock Retention Rules

Object Lock Retention Rules overview

Object Lock Retention Rules let CS Browser apply Object Lock settings automatically when you upload files to Amazon S3.

CS Browser checks each upload against the configured bucket and file masks, then applies the retention settings from a matching rule.

These rules are stored locally and are specific to CS Browser and the computer on which they were created. If you upload files from another computer, the rules will not apply. You can transfer the rules file between computers by copying %APPDATA%\S3Browser\bucket.rules.

Amazon S3 also provides default retention settings at the bucket level. Because default retention is an Amazon S3 feature, it applies independently of the application or computer used for the upload.

Advantages of CS Browser Object Lock Retention Rules

• Flexible matching - A rule can cover a single file, folder, or bucket, or a group of files, folders, or buckets.
• Legal Hold support - Unlike Amazon S3 default retention settings, CS Browser Object Lock Retention Rules can apply a Legal Hold automatically.

Limitation

• Computer and application specific - These rules are stored locally. They do not apply to uploads made from another computer or application.

How to add a retention rule

1. Start CS Browser and choose Tools > Object Lock Retention Rules..

   

   The Object Lock Retention Rules dialog will open:

   

2. Click Add. The Add New Object Lock Retention Rule dialog will open:

   

3. Configure the rule:

   Bucket name or mask - Identifies one or more buckets to which the rule applies. An empty bucket name means all buckets.

   Remote file name or mask - Identifies one or more files to which the rule applies, for example docs/* or *.xls. An empty file name means all files.

   Retention mode - Selects the level of protection applied to matching object versions.

   Governance mode - Users cannot overwrite or delete a protected object version or change its lock settings unless they have permission to bypass governance retention.

   Compliance mode - A protected object version cannot be overwritten or deleted by any user, including the root user. Its retention mode cannot be changed and its retention period cannot be shortened.

   Retention duration calculation method - Calculates the retention deadline relative to the upload date or uses a fixed expiration date.

   Relative to upload date - Retains each file for the configured number of days or years after it is uploaded.

   Fixed expiration date - Retains every matching file until the specified date, regardless of when it was uploaded.

   Place a legal hold on an object version - Applies an Object Lock Legal Hold to the uploaded file.

   Enabled - Makes the rule active. Clear this option to keep the rule without applying it to uploads.

4. Click Add, then click Save changes.

How to edit a retention rule

1. Select the rule you want to edit and click Edit.

   

2. The Edit Object Lock Retention Rule dialog will open:

   

3. Modify the required fields and click Save changes. Then click Save changes in the rules dialog.

How to delete retention rules

1. Select one or more rules and click Delete.

   

2. Click Save changes.

Additional features

The commands described above, rule ordering, selection commands, copy and paste, and keyboard shortcuts are also available from the context menu.

Related materials