Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PutObjectLockConfigurationRequest

Hierarchy

Index

Properties

Bucket

Bucket: string | undefined

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

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

Optional ChecksumAlgorithm

ChecksumAlgorithm: ChecksumAlgorithm | 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.

Optional ContentMD5

ContentMD5: undefined | 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.

Optional ExpectedBucketOwner

ExpectedBucketOwner: undefined | 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).

Optional ObjectLockConfiguration

ObjectLockConfiguration: ObjectLockConfiguration

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

Optional RequestPayer

RequestPayer: RequestPayer | 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.

Optional Token

Token: undefined | string

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