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

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 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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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

#checksum_algorithmString

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)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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

#content_md5String

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)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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_ownerString

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)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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_configurationTypes::ObjectLockConfiguration

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



13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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

#request_payerString

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)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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

#tokenString

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

Returns:

  • (String)


13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13298

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