Class: Aws::S3::Types::ObjectLockRule

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ObjectLockRule

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

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

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

The container element for an Object Lock rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_retention ⇒ Types::DefaultRetention

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

Instance Attribute Details

#default_retention ⇒ Types::DefaultRetention

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either ‘Days` or `Years` but you must select one. You cannot specify `Days` and `Years` at the same time.

Returns:

• (Types::DefaultRetention)

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

class ObjectLockRule < Struct.new(
  :default_retention)
  SENSITIVE = []
  include Aws::Structure
end