s3/aws.sdk.kotlin.services.s3.model/PutObjectLegalHoldRequest/Builder

Builder

Properties

The bucket name containing the object that you want to place a legal hold on.

var checksumAlgorithm: ChecksumAlgorithm?

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.

contentMd5

var contentMd5: String?

The MD5 hash for the request body.

expectedBucketOwner

var expectedBucketOwner: String?

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

key

var key: String?

The key name for the object that you want to place a legal hold on.

legalHold

var legalHold: ObjectLockLegalHold?

Container element for the legal hold configuration you want to apply to the specified object.

requestPayer

var requestPayer: RequestPayer?

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

versionId

var versionId: String?

The version ID of the object that you want to place a legal hold on.

Functions

legalHold

fun legalHold(block: ObjectLockLegalHold.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.s3.model.ObjectLockLegalHold inside the given block