You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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:

Instance Attribute Summary collapse

Instance Attribute Details

#modeString

Indicates the Retention mode for the specified object.

Possible values:

  • GOVERNANCE
  • COMPLIANCE

Returns:

  • (String)

    Indicates the Retention mode for the specified object.

#retain_until_dateTime

The date on which this Object Lock Retention will expire.

Returns:

  • (Time)

    The date on which this Object Lock Retention will expire.