Class: Aws::S3::Types::PutObjectLockConfigurationRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  object_lock_configuration: {
    object_lock_enabled: "Enabled", # accepts Enabled
    rule: {
      default_retention: {
        mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
        days: 1,
        years: 1,
      },
    },
  },
  request_payer: "requester", # accepts requester
  token: "ObjectLockToken",
  content_md5: "ContentMD5",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket whose Object Lock configuration you want to create or replace.

Returns:

  • (String) 


7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/aws-sdk-s3/types.rb', line 7591

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  include Aws::Structure
end

#content_md5 ⇒ String

The MD5 hash for the request body.

Returns:

  • (String) 


7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/aws-sdk-s3/types.rb', line 7591

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  include Aws::Structure
end

#object_lock_configuration ⇒ Types::ObjectLockConfiguration

The Object Lock configuration that you want to apply to the specified bucket.

Returns:



7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/aws-sdk-s3/types.rb', line 7591

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String) 


7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/aws-sdk-s3/types.rb', line 7591

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  include Aws::Structure
end

#token ⇒ String

Returns:

  • (String) 


7591
7592
7593
7594
7595
7596
7597
7598
 
# File 'lib/aws-sdk-s3/types.rb', line 7591

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  include Aws::Structure
end