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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

A Retention configuration for an object.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_hold ⇒ String

The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

Returns:

  • (String) 


15202
15203
15204
15205
15206
15207
15208
15209
 
# File 'lib/aws-sdk-s3/types.rb', line 15202

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

#event_hold_duration ⇒ Types::EventHoldDuration

The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

Returns:



15202
15203
15204
15205
15206
15207
15208
15209
 
# File 'lib/aws-sdk-s3/types.rb', line 15202

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

#mode ⇒ String

Indicates the Retention mode for the specified object.

Returns:

  • (String) 


15202
15203
15204
15205
15206
15207
15208
15209
 
# File 'lib/aws-sdk-s3/types.rb', line 15202

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

#retain_until_date ⇒ Time

The date on which this Object Lock Retention will expire.

Returns:

  • (Time) 


15202
15203
15204
15205
15206
15207
15208
15209
 
# File 'lib/aws-sdk-s3/types.rb', line 15202

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