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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_hold ⇒ String

The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

Returns:

  • (String) 


8030
8031
8032
8033
8034
8035
8036
8037
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 8030

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

#event_hold_duration ⇒ Types::S3ObjectLockRetentionEventHoldDuration

The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

Returns:



8030
8031
8032
8033
8034
8035
8036
8037
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 8030

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

#mode ⇒ String

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

Returns:

  • (String) 


8030
8031
8032
8033
8034
8035
8036
8037
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 8030

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

#retain_until_date ⇒ Time

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

Returns:

  • (Time) 


8030
8031
8032
8033
8034
8035
8036
8037
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 8030

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