commonMain.aws.sdk.kotlin.services.s3.model.CreateMultipartUploadRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.s3.model
import aws.smithy.kotlin.runtime.time.Instant
public class CreateMultipartUploadRequest private constructor(builder: Builder) {
/**
* The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as *canned ACLs*. Each canned ACL has a predefined set of grantees and permissions. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) in the *Amazon S3 User Guide*.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see [Using ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). One way to grant the permissions using the request headers is to specify a canned ACL with the `x-amz-acl` request header.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = builder.acl
/**
* The name of the bucket where the multipart upload is initiated and where the object is uploaded.
*
* **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ` Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name--az-id--x-s3` (for example, ` DOC-EXAMPLE-BUCKET--usw2-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) in the *Amazon S3 User Guide*.
*
* **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the *Amazon S3 User Guide*.
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
* **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ` AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public val bucket: kotlin.String? = builder.bucket
/**
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
*
* Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
*
* This functionality is not supported for directory buckets.
*/
public val bucketKeyEnabled: kotlin.Boolean? = builder.bucketKeyEnabled
/**
* Specifies caching behavior along the request/reply chain.
*/
public val cacheControl: kotlin.String? = builder.cacheControl
/**
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = builder.checksumAlgorithm
/**
* Specifies presentational information for the object.
*/
public val contentDisposition: kotlin.String? = builder.contentDisposition
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*
* For directory buckets, only the `aws-chunked` value is supported in this header field.
*/
public val contentEncoding: kotlin.String? = builder.contentEncoding
/**
* The language that the content is in.
*/
public val contentLanguage: kotlin.String? = builder.contentLanguage
/**
* A standard MIME type describing the format of the object data.
*/
public val contentType: kotlin.String? = builder.contentType
/**
* 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).
*/
public val expectedBucketOwner: kotlin.String? = builder.expectedBucketOwner
/**
* The date and time at which the object is no longer cacheable.
*/
public val expires: aws.smithy.kotlin.runtime.time.Instant? = builder.expires
/**
* Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantFullControl: kotlin.String? = builder.grantFullControl
/**
* Specify access permissions explicitly to allow grantee to read the object data and its metadata.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantRead: kotlin.String? = builder.grantRead
/**
* Specify access permissions explicitly to allows grantee to read the object ACL.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantReadAcp: kotlin.String? = builder.grantReadAcp
/**
* Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantWriteAcp: kotlin.String? = builder.grantWriteAcp
/**
* Object key for which the multipart upload is to be initiated.
*/
public val key: kotlin.String? = builder.key
/**
* A map of metadata to store with the object in S3.
*/
public val metadata: Map? = builder.metadata
/**
* Specifies whether you want to apply a legal hold to the uploaded object.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockLegalHoldStatus: aws.sdk.kotlin.services.s3.model.ObjectLockLegalHoldStatus? = builder.objectLockLegalHoldStatus
/**
* Specifies the Object Lock mode that you want to apply to the uploaded object.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockMode: aws.sdk.kotlin.services.s3.model.ObjectLockMode? = builder.objectLockMode
/**
* Specifies the date and time when you want the Object Lock to expire.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockRetainUntilDate: aws.smithy.kotlin.runtime.time.Instant? = builder.objectLockRetainUntilDate
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = builder.requestPayer
/**
* The server-side encryption algorithm used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`).
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) is supported.
*/
public val serverSideEncryption: aws.sdk.kotlin.services.s3.model.ServerSideEncryption? = builder.serverSideEncryption
/**
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerAlgorithm: kotlin.String? = builder.sseCustomerAlgorithm
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the `x-amz-server-side-encryption-customer-algorithm` header.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKey: kotlin.String? = builder.sseCustomerKey
/**
* Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKeyMd5: kotlin.String? = builder.sseCustomerKeyMd5
/**
* Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
*
* This functionality is not supported for directory buckets.
*/
public val ssekmsEncryptionContext: kotlin.String? = builder.ssekmsEncryptionContext
/**
* Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption.
*
* This functionality is not supported for directory buckets.
*/
public val ssekmsKeyId: kotlin.String? = builder.ssekmsKeyId
/**
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see [Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the *Amazon S3 User Guide*.
*
* + For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
* + Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*/
public val storageClass: aws.sdk.kotlin.services.s3.model.StorageClass? = builder.storageClass
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters.
*
* This functionality is not supported for directory buckets.
*/
public val tagging: kotlin.String? = builder.tagging
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*
* This functionality is not supported for directory buckets.
*/
public val websiteRedirectLocation: kotlin.String? = builder.websiteRedirectLocation
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.s3.model.CreateMultipartUploadRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateMultipartUploadRequest(")
append("acl=$acl,")
append("bucket=$bucket,")
append("bucketKeyEnabled=$bucketKeyEnabled,")
append("cacheControl=$cacheControl,")
append("checksumAlgorithm=$checksumAlgorithm,")
append("contentDisposition=$contentDisposition,")
append("contentEncoding=$contentEncoding,")
append("contentLanguage=$contentLanguage,")
append("contentType=$contentType,")
append("expectedBucketOwner=$expectedBucketOwner,")
append("expires=$expires,")
append("grantFullControl=$grantFullControl,")
append("grantRead=$grantRead,")
append("grantReadAcp=$grantReadAcp,")
append("grantWriteAcp=$grantWriteAcp,")
append("key=$key,")
append("metadata=$metadata,")
append("objectLockLegalHoldStatus=$objectLockLegalHoldStatus,")
append("objectLockMode=$objectLockMode,")
append("objectLockRetainUntilDate=$objectLockRetainUntilDate,")
append("requestPayer=$requestPayer,")
append("serverSideEncryption=$serverSideEncryption,")
append("sseCustomerAlgorithm=$sseCustomerAlgorithm,")
append("sseCustomerKey=*** Sensitive Data Redacted ***,")
append("sseCustomerKeyMd5=$sseCustomerKeyMd5,")
append("ssekmsEncryptionContext=*** Sensitive Data Redacted ***,")
append("ssekmsKeyId=*** Sensitive Data Redacted ***,")
append("storageClass=$storageClass,")
append("tagging=$tagging,")
append("websiteRedirectLocation=$websiteRedirectLocation")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = acl?.hashCode() ?: 0
result = 31 * result + (bucket?.hashCode() ?: 0)
result = 31 * result + (bucketKeyEnabled?.hashCode() ?: 0)
result = 31 * result + (cacheControl?.hashCode() ?: 0)
result = 31 * result + (checksumAlgorithm?.hashCode() ?: 0)
result = 31 * result + (contentDisposition?.hashCode() ?: 0)
result = 31 * result + (contentEncoding?.hashCode() ?: 0)
result = 31 * result + (contentLanguage?.hashCode() ?: 0)
result = 31 * result + (contentType?.hashCode() ?: 0)
result = 31 * result + (expectedBucketOwner?.hashCode() ?: 0)
result = 31 * result + (expires?.hashCode() ?: 0)
result = 31 * result + (grantFullControl?.hashCode() ?: 0)
result = 31 * result + (grantRead?.hashCode() ?: 0)
result = 31 * result + (grantReadAcp?.hashCode() ?: 0)
result = 31 * result + (grantWriteAcp?.hashCode() ?: 0)
result = 31 * result + (key?.hashCode() ?: 0)
result = 31 * result + (metadata?.hashCode() ?: 0)
result = 31 * result + (objectLockLegalHoldStatus?.hashCode() ?: 0)
result = 31 * result + (objectLockMode?.hashCode() ?: 0)
result = 31 * result + (objectLockRetainUntilDate?.hashCode() ?: 0)
result = 31 * result + (requestPayer?.hashCode() ?: 0)
result = 31 * result + (serverSideEncryption?.hashCode() ?: 0)
result = 31 * result + (sseCustomerAlgorithm?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKey?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKeyMd5?.hashCode() ?: 0)
result = 31 * result + (ssekmsEncryptionContext?.hashCode() ?: 0)
result = 31 * result + (ssekmsKeyId?.hashCode() ?: 0)
result = 31 * result + (storageClass?.hashCode() ?: 0)
result = 31 * result + (tagging?.hashCode() ?: 0)
result = 31 * result + (websiteRedirectLocation?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreateMultipartUploadRequest
if (acl != other.acl) return false
if (bucket != other.bucket) return false
if (bucketKeyEnabled != other.bucketKeyEnabled) return false
if (cacheControl != other.cacheControl) return false
if (checksumAlgorithm != other.checksumAlgorithm) return false
if (contentDisposition != other.contentDisposition) return false
if (contentEncoding != other.contentEncoding) return false
if (contentLanguage != other.contentLanguage) return false
if (contentType != other.contentType) return false
if (expectedBucketOwner != other.expectedBucketOwner) return false
if (expires != other.expires) return false
if (grantFullControl != other.grantFullControl) return false
if (grantRead != other.grantRead) return false
if (grantReadAcp != other.grantReadAcp) return false
if (grantWriteAcp != other.grantWriteAcp) return false
if (key != other.key) return false
if (metadata != other.metadata) return false
if (objectLockLegalHoldStatus != other.objectLockLegalHoldStatus) return false
if (objectLockMode != other.objectLockMode) return false
if (objectLockRetainUntilDate != other.objectLockRetainUntilDate) return false
if (requestPayer != other.requestPayer) return false
if (serverSideEncryption != other.serverSideEncryption) return false
if (sseCustomerAlgorithm != other.sseCustomerAlgorithm) return false
if (sseCustomerKey != other.sseCustomerKey) return false
if (sseCustomerKeyMd5 != other.sseCustomerKeyMd5) return false
if (ssekmsEncryptionContext != other.ssekmsEncryptionContext) return false
if (ssekmsKeyId != other.ssekmsKeyId) return false
if (storageClass != other.storageClass) return false
if (tagging != other.tagging) return false
if (websiteRedirectLocation != other.websiteRedirectLocation) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.s3.model.CreateMultipartUploadRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as *canned ACLs*. Each canned ACL has a predefined set of grantees and permissions. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) in the *Amazon S3 User Guide*.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see [Using ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). One way to grant the permissions using the request headers is to specify a canned ACL with the `x-amz-acl` request header.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = null
/**
* The name of the bucket where the multipart upload is initiated and where the object is uploaded.
*
* **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ` Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name--az-id--x-s3` (for example, ` DOC-EXAMPLE-BUCKET--usw2-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) in the *Amazon S3 User Guide*.
*
* **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the *Amazon S3 User Guide*.
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
* **S3 on Outposts** - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ` AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public var bucket: kotlin.String? = null
/**
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
*
* Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
*
* This functionality is not supported for directory buckets.
*/
public var bucketKeyEnabled: kotlin.Boolean? = null
/**
* Specifies caching behavior along the request/reply chain.
*/
public var cacheControl: kotlin.String? = null
/**
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = null
/**
* Specifies presentational information for the object.
*/
public var contentDisposition: kotlin.String? = null
/**
* Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
*
* For directory buckets, only the `aws-chunked` value is supported in this header field.
*/
public var contentEncoding: kotlin.String? = null
/**
* The language that the content is in.
*/
public var contentLanguage: kotlin.String? = null
/**
* A standard MIME type describing the format of the object data.
*/
public var contentType: kotlin.String? = null
/**
* 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).
*/
public var expectedBucketOwner: kotlin.String? = null
/**
* The date and time at which the object is no longer cacheable.
*/
public var expires: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantFullControl: kotlin.String? = null
/**
* Specify access permissions explicitly to allow grantee to read the object data and its metadata.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantRead: kotlin.String? = null
/**
* Specify access permissions explicitly to allows grantee to read the object ACL.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantReadAcp: kotlin.String? = null
/**
* Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
*
* By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon S3 User Guide*.
*
* You specify each grantee as a type=value pair, where the type is one of the following:
* + `id` – if the value specified is the canonical user ID of an Amazon Web Services account
* + `uri` – if you are granting permissions to a predefined group
* + `emailAddress` – if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
* + US East (N. Virginia)
* + US West (N. California)
* + US West (Oregon)
* + Asia Pacific (Singapore)
* + Asia Pacific (Sydney)
* + Asia Pacific (Tokyo)
* + Europe (Ireland)
* + South America (São Paulo)
* For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the Amazon Web Services General Reference.
*
* For example, the following `x-amz-grant-read` header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
*
* `x-amz-grant-read: id="11112222333", id="444455556666" `
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantWriteAcp: kotlin.String? = null
/**
* Object key for which the multipart upload is to be initiated.
*/
public var key: kotlin.String? = null
/**
* A map of metadata to store with the object in S3.
*/
public var metadata: Map? = null
/**
* Specifies whether you want to apply a legal hold to the uploaded object.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockLegalHoldStatus: aws.sdk.kotlin.services.s3.model.ObjectLockLegalHoldStatus? = null
/**
* Specifies the Object Lock mode that you want to apply to the uploaded object.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockMode: aws.sdk.kotlin.services.s3.model.ObjectLockMode? = null
/**
* Specifies the date and time when you want the Object Lock to expire.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockRetainUntilDate: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = null
/**
* The server-side encryption algorithm used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`).
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) is supported.
*/
public var serverSideEncryption: aws.sdk.kotlin.services.s3.model.ServerSideEncryption? = null
/**
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerAlgorithm: kotlin.String? = null
/**
* Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the `x-amz-server-side-encryption-customer-algorithm` header.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKey: kotlin.String? = null
/**
* Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKeyMd5: kotlin.String? = null
/**
* Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
*
* This functionality is not supported for directory buckets.
*/
public var ssekmsEncryptionContext: kotlin.String? = null
/**
* Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption.
*
* This functionality is not supported for directory buckets.
*/
public var ssekmsKeyId: kotlin.String? = null
/**
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see [Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the *Amazon S3 User Guide*.
*
* + For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
* + Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*/
public var storageClass: aws.sdk.kotlin.services.s3.model.StorageClass? = null
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters.
*
* This functionality is not supported for directory buckets.
*/
public var tagging: kotlin.String? = null
/**
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
*
* This functionality is not supported for directory buckets.
*/
public var websiteRedirectLocation: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.s3.model.CreateMultipartUploadRequest) : this() {
this.acl = x.acl
this.bucket = x.bucket
this.bucketKeyEnabled = x.bucketKeyEnabled
this.cacheControl = x.cacheControl
this.checksumAlgorithm = x.checksumAlgorithm
this.contentDisposition = x.contentDisposition
this.contentEncoding = x.contentEncoding
this.contentLanguage = x.contentLanguage
this.contentType = x.contentType
this.expectedBucketOwner = x.expectedBucketOwner
this.expires = x.expires
this.grantFullControl = x.grantFullControl
this.grantRead = x.grantRead
this.grantReadAcp = x.grantReadAcp
this.grantWriteAcp = x.grantWriteAcp
this.key = x.key
this.metadata = x.metadata
this.objectLockLegalHoldStatus = x.objectLockLegalHoldStatus
this.objectLockMode = x.objectLockMode
this.objectLockRetainUntilDate = x.objectLockRetainUntilDate
this.requestPayer = x.requestPayer
this.serverSideEncryption = x.serverSideEncryption
this.sseCustomerAlgorithm = x.sseCustomerAlgorithm
this.sseCustomerKey = x.sseCustomerKey
this.sseCustomerKeyMd5 = x.sseCustomerKeyMd5
this.ssekmsEncryptionContext = x.ssekmsEncryptionContext
this.ssekmsKeyId = x.ssekmsKeyId
this.storageClass = x.storageClass
this.tagging = x.tagging
this.websiteRedirectLocation = x.websiteRedirectLocation
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.s3.model.CreateMultipartUploadRequest = CreateMultipartUploadRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy