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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#object_lock_enabledString

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

Returns:

  • (String)


9562
9563
9564
9565
9566
9567
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9562

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

#ruleTypes::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.



9562
9563
9564
9565
9566
9567
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9562

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