HCP Tenant Management Help


Retention

The retention setting determines how long the object must remain in the bucket before it can be deleted. This can range from allowing the object to be deleted at any time to preventing the object from ever being deleted. While an object cannot be deleted due to retention, it is said to be under retention. You can use the S3 compatible API to change the retention setting for an object.

Default retention setting

Each bucket in HCP has a default retention setting. This is the setting that’s applied to objects when they’re first stored in the bucket. When you create a bucket, its default retention setting is to allow deletion at any time.

Hold

Objects can be placed on hold. An object on hold cannot be deleted and its retention setting cannot be changed. You can use the S3 compatible API to place objects on hold or release them from being on hold.

Privileged delete

Privileged delete enables you to delete objects even if they are under retention. However, you cannot use privileged delete operations to delete objects that are on hold, regardless of the retention settings of those objects.

Retention periods

The retention period for an object is the length of time the object must remain in the bucket. A retention period can be a specific length of time, infinite time, or no time, in which case the object can be deleted at any time.

When the retention period for an object expires, the object becomes deletable.

Normally, if you try to delete an object that’s under retention, HCP prevents you from doing so. For the exception, see Deleting an object under retention.

Retention classes

A retention class is a named retention setting. Retention classes let you manage object retention consistently by specifying how long the object must remain in the repository. Retention classes cannot be created using the S3 compatible API. For more information about retention classes, see Retention classes.

Automatic deletion

A bucket can be configured to automatically delete objects after their retention periods expire. For an object to be deleted automatically:

A specified retention period must expire. Objects with Deletion Allowed (0) or Initial Unspecified (-2) retention settings are not automatically deleted.

If the object is in a retention class, the class must have automatic deletion enabled.

Automatic deletion cannot be configured using the S3 compatible API. For information about changing these settings, see Changing disposition settings.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.