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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::DefaultRetention

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>

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #days ⇒ Integer

  The number of days that you want to specify for the default retention period.

• #mode ⇒ String

  The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

• #years ⇒ Integer

  The number of years that you want to specify for the default retention period.

Instance Attribute Details

#days ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 2733

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

#mode ⇒ String

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)

# File 'lib/aws-sdk-s3/types.rb', line 2733

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

#years ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 2733

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