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

Inherits:

Struct

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

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3control/types.rb

Overview

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying ‘PutObjectRetention` API operation. For more information, see [Using S3 Object Lock retention with S3 Batch Operations] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported by directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html

Constant Summary collapse

SENSITIVE =

[]

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)

# File 'lib/aws-sdk-s3control/types.rb', line 7520

class S3SetObjectRetentionOperation < Struct.new(
  :bypass_governance_retention,
  :retention)
  SENSITIVE = []
  include Aws::Structure
end

#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 S3 User Guide*.