Class: Aws::S3::Types::DefaultRetention

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

Overview

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

* The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#daysInteger

The number of days that you want to specify for the default retention period. Must be used with Mode.

Returns:

  • (Integer)


3365
3366
3367
3368
3369
3370
3371
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3365

class DefaultRetention < Struct.new(
  :mode,
  :days,
  :years)
  SENSITIVE = []
  include Aws::Structure
end

#modeString

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

Returns:

  • (String)


3365
3366
3367
3368
3369
3370
3371
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3365

class DefaultRetention < Struct.new(
  :mode,
  :days,
  :years)
  SENSITIVE = []
  include Aws::Structure
end

#yearsInteger

The number of years that you want to specify for the default retention period. Must be used with Mode.

Returns:

  • (Integer)


3365
3366
3367
3368
3369
3370
3371
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3365

class DefaultRetention < Struct.new(
  :mode,
  :days,
  :years)
  SENSITIVE = []
  include Aws::Structure
end