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

Class: Aws::S3Control::Types::S3SetObjectRetentionOperation

Inherits:

Struct

Object
Struct
Aws::S3Control::Types::S3SetObjectRetentionOperation

show all

Defined in:: (unknown)

Overview

Note:

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

{
  bypass_governance_retention: false,
  retention: { # required
    retain_until_date: Time.now,
    mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
  },
}

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes each value through to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Returned by:

JobOperation#s3_put_object_retention

Instance Attribute Summary collapse

#bypass_governance_retention ⇒ Boolean
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.
#retention ⇒ Types::S3Retention
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job.

Instance Attribute Details

#bypass_governance_retention ⇒ `Boolean`

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

Returns:

(Boolean) —
Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

#retention ⇒ `Types::S3Retention`

Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.