Class: Aws::S3::Types::ObjectLockConfiguration

Inherits:

Struct

Object
Struct
Aws::S3::Types::ObjectLockConfiguration

show all

Defined in:: gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

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

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

The container element for Object Lock configuration parameters.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#object_lock_enabled ⇒ String
Indicates whether this bucket has an Object Lock configuration enabled.
#rule ⇒ Types::ObjectLockRule
Specifies the Object Lock rule for the specified object.

Instance Attribute Details

#object_lock_enabled ⇒ `String`

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

(String)

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

class ObjectLockConfiguration < Struct.new(
  :object_lock_enabled,
  :rule)
  SENSITIVE = []
  include Aws::Structure
end

#rule ⇒ `Types::ObjectLockRule`

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a 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.