You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DefaultRetention as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#daysInteger

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

Returns:

  • (Integer)

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

#modeString

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

Possible values:

  • GOVERNANCE
  • COMPLIANCE

Returns:

  • (String)

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

#yearsInteger

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

Returns:

  • (Integer)

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