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

Class: Aws::S3Control::Types::S3ObjectLockLegalHold

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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

{
  status: "OFF", # required, accepts OFF, ON
}

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#statusString

The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

Possible values:

  • OFF
  • ON

Returns:

  • (String)

    The Object Lock legal hold status to be applied to all objects in the Batch Operations job.