Class: Aws::S3Control::Types::S3Retention

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

When making an API call, you may pass S3Retention data as a hash:

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

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#modeString

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

Returns:

  • (String)


5707
5708
5709
5710
5711
5712
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5707

class S3Retention < Struct.new(
  :retain_until_date,
  :mode)
  SENSITIVE = []
  include Aws::Structure
end

#retain_until_dateTime

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Returns:

  • (Time)


5707
5708
5709
5710
5711
5712
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5707

class S3Retention < Struct.new(
  :retain_until_date,
  :mode)
  SENSITIVE = []
  include Aws::Structure
end