Class: Aws::S3::Types::ObjectLockRetention

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ObjectLockRetention

Defined in:

(unknown)

Overview

Note:

When passing ObjectLockRetention as input to an Aws::Client method, you can use a vanilla Hash:

{
  mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  retain_until_date: Time.now,
}

A Retention configuration for an object.

Returned by:

• GetObjectRetentionOutput#retention
• PutObjectRetentionRequest#retention

See Also:

• AWS API Documentation

Instance Attribute Summary

• #mode ⇒ String

  Indicates the Retention mode for the specified object.

• #retain_until_date ⇒ Time

  The date on which this Object Lock Retention will expire.

Instance Attribute Details

#mode ⇒ String

Indicates the Retention mode for the specified object.

Possible values:

• GOVERNANCE
• COMPLIANCE

Returns:

• (String) —

  Indicates the Retention mode for the specified object.

#retain_until_date ⇒ Time

The date on which this Object Lock Retention will expire.

Returns:

• (Time) —

  The date on which this Object Lock Retention will expire.