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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutObjectLockConfigurationRequest

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #checksum_algorithm ⇒ String

  Indicates the algorithm used to create the checksum for the object when using the SDK.

• #content_md5 ⇒ String

  The MD5 hash for the request body.

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

• #object_lock_configuration ⇒ Types::ObjectLockConfiguration

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

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

• #token ⇒ String

  A token to allow Object Lock to be enabled for an existing bucket.

Instance Attribute Details

#bucket ⇒ String

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

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ String

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_configuration ⇒ Types::ObjectLockConfiguration

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

Returns:

• (Types::ObjectLockConfiguration)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#token ⇒ String

A token to allow Object Lock to be enabled for an existing bucket.

Returns:

• (String)

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

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end