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

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

Overview

Note:

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

{
  mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  days: 1,
  years: 1,
}

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

<note markdown=“1”> * 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.

</note>

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)

2274
2275
2276
2277
2278
2279
2280
# File 'lib/aws-sdk-s3/types.rb', line 2274

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)

2274
2275
2276
2277
2278
2279
2280
# File 'lib/aws-sdk-s3/types.rb', line 2274

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)

2274
2275
2276
2277
2278
2279
2280
# File 'lib/aws-sdk-s3/types.rb', line 2274

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