software.amazon.awssdk.services.s3.model

Interface CreateMultipartUploadRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>, S3Request.Builder, SdkBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateMultipartUploadRequest

public static interface CreateMultipartUploadRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>

Method Summary

Modifier and Type	Method and Description
CreateMultipartUploadRequest.Builder	acl(ObjectCannedACL acl) The canned ACL to apply to the object.
CreateMultipartUploadRequest.Builder	acl(String acl) The canned ACL to apply to the object.
CreateMultipartUploadRequest.Builder	bucket(String bucket) The name of the bucket to which to initiate the upload
CreateMultipartUploadRequest.Builder	bucketKeyEnabled(Boolean bucketKeyEnabled) Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS).
CreateMultipartUploadRequest.Builder	cacheControl(String cacheControl) Specifies caching behavior along the request/reply chain.
CreateMultipartUploadRequest.Builder	contentDisposition(String contentDisposition) Specifies presentational information for the object.
CreateMultipartUploadRequest.Builder	contentEncoding(String contentEncoding) 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.
CreateMultipartUploadRequest.Builder	contentLanguage(String contentLanguage) The language the content is in.
CreateMultipartUploadRequest.Builder	contentType(String contentType) A standard MIME type describing the format of the object data.
CreateMultipartUploadRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
CreateMultipartUploadRequest.Builder	expires(Instant expires) The date and time at which the object is no longer cacheable.
CreateMultipartUploadRequest.Builder	grantFullControl(String grantFullControl) Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
CreateMultipartUploadRequest.Builder	grantRead(String grantRead) Allows grantee to read the object data and its metadata.
CreateMultipartUploadRequest.Builder	grantReadACP(String grantReadACP) Allows grantee to read the object ACL.
CreateMultipartUploadRequest.Builder	grantWriteACP(String grantWriteACP) Allows grantee to write the ACL for the applicable object.
CreateMultipartUploadRequest.Builder	key(String key) Object key for which the multipart upload is to be initiated.
CreateMultipartUploadRequest.Builder	metadata(Map<String,String> metadata) A map of metadata to store with the object in S3.
CreateMultipartUploadRequest.Builder	objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the uploaded object.
CreateMultipartUploadRequest.Builder	objectLockLegalHoldStatus(String objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the uploaded object.
CreateMultipartUploadRequest.Builder	objectLockMode(ObjectLockMode objectLockMode) Specifies the Object Lock mode that you want to apply to the uploaded object.
CreateMultipartUploadRequest.Builder	objectLockMode(String objectLockMode) Specifies the Object Lock mode that you want to apply to the uploaded object.
CreateMultipartUploadRequest.Builder	objectLockRetainUntilDate(Instant objectLockRetainUntilDate) Specifies the date and time when you want the Object Lock to expire.
CreateMultipartUploadRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateMultipartUploadRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateMultipartUploadRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
CreateMultipartUploadRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
CreateMultipartUploadRequest.Builder	serverSideEncryption(ServerSideEncryption serverSideEncryption) The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
CreateMultipartUploadRequest.Builder	serverSideEncryption(String serverSideEncryption) The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
CreateMultipartUploadRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use to when encrypting the object (for example, AES256).
CreateMultipartUploadRequest.Builder	sseCustomerKey(String sseCustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
CreateMultipartUploadRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
CreateMultipartUploadRequest.Builder	ssekmsEncryptionContext(String ssekmsEncryptionContext) Specifies the AWS KMS Encryption Context to use for object encryption.
CreateMultipartUploadRequest.Builder	ssekmsKeyId(String ssekmsKeyId) Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption.
CreateMultipartUploadRequest.Builder	storageClass(StorageClass storageClass) By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
CreateMultipartUploadRequest.Builder	storageClass(String storageClass) By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
CreateMultipartUploadRequest.Builder	tagging(String tagging) The tag-set for the object.
CreateMultipartUploadRequest.Builder	tagging(Tagging tagging)
CreateMultipartUploadRequest.Builder	websiteRedirectLocation(String websiteRedirectLocation) 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.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

acl

CreateMultipartUploadRequest.Builder acl(String acl)

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Parameters:

acl - The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL, ObjectCannedACL

acl

CreateMultipartUploadRequest.Builder acl(ObjectCannedACL acl)

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Parameters:

acl - The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL, ObjectCannedACL

bucket

CreateMultipartUploadRequest.Builder bucket(String bucket)

The name of the bucket to which to initiate the upload

When using this action with an access point, 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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Parameters:

bucket - The name of the bucket to which to initiate the upload

When using this action with an access point, 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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using 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 using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheControl

CreateMultipartUploadRequest.Builder cacheControl(String cacheControl)

Specifies caching behavior along the request/reply chain.

Parameters:

cacheControl - Specifies caching behavior along the request/reply chain.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentDisposition

CreateMultipartUploadRequest.Builder contentDisposition(String contentDisposition)

Specifies presentational information for the object.

Parameters:

contentDisposition - Specifies presentational information for the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentEncoding

CreateMultipartUploadRequest.Builder contentEncoding(String contentEncoding)

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.

Parameters:

contentEncoding - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentLanguage

CreateMultipartUploadRequest.Builder contentLanguage(String contentLanguage)

The language the content is in.

Parameters:

contentLanguage - The language the content is in.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentType

CreateMultipartUploadRequest.Builder contentType(String contentType)

A standard MIME type describing the format of the object data.

Parameters:

contentType - A standard MIME type describing the format of the object data.

Returns:

Returns a reference to this object so that method calls can be chained together.

expires

CreateMultipartUploadRequest.Builder expires(Instant expires)

The date and time at which the object is no longer cacheable.

Parameters:

expires - The date and time at which the object is no longer cacheable.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantFullControl

CreateMultipartUploadRequest.Builder grantFullControl(String grantFullControl)

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

Parameters:

grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantRead

CreateMultipartUploadRequest.Builder grantRead(String grantRead)

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Parameters:

grantRead - Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantReadACP

CreateMultipartUploadRequest.Builder grantReadACP(String grantReadACP)

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Parameters:

grantReadACP - Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantWriteACP

CreateMultipartUploadRequest.Builder grantWriteACP(String grantWriteACP)

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Parameters:

grantWriteACP - Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Returns:

Returns a reference to this object so that method calls can be chained together.

key

CreateMultipartUploadRequest.Builder key(String key)

Object key for which the multipart upload is to be initiated.

Parameters:

key - Object key for which the multipart upload is to be initiated.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

CreateMultipartUploadRequest.Builder metadata(Map<String,String> metadata)

A map of metadata to store with the object in S3.

Parameters:

metadata - A map of metadata to store with the object in S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverSideEncryption

CreateMultipartUploadRequest.Builder serverSideEncryption(String serverSideEncryption)

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption, ServerSideEncryption

serverSideEncryption

CreateMultipartUploadRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption, ServerSideEncryption

storageClass

CreateMultipartUploadRequest.Builder storageClass(String storageClass)

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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Parameters:

storageClass - 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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass

storageClass

CreateMultipartUploadRequest.Builder storageClass(StorageClass storageClass)

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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Parameters:

storageClass - 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. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass

websiteRedirectLocation

CreateMultipartUploadRequest.Builder websiteRedirectLocation(String websiteRedirectLocation)

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.

Parameters:

websiteRedirectLocation - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerAlgorithm

CreateMultipartUploadRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for example, AES256).

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerKey

CreateMultipartUploadRequest.Builder sseCustomerKey(String sseCustomerKey)

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.

Parameters:

sseCustomerKey - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerKeyMD5

CreateMultipartUploadRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

Specifies the 128-bit MD5 digest of the 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.

Parameters:

sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

ssekmsKeyId

CreateMultipartUploadRequest.Builder ssekmsKeyId(String ssekmsKeyId)

Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Parameters:

ssekmsKeyId - Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

ssekmsEncryptionContext

CreateMultipartUploadRequest.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)

Specifies the AWS 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.

Parameters:

ssekmsEncryptionContext - Specifies the AWS 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

bucketKeyEnabled

CreateMultipartUploadRequest.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (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.

Parameters:

bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (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.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestPayer

CreateMultipartUploadRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

requestPayer

CreateMultipartUploadRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer, RequestPayer

tagging

CreateMultipartUploadRequest.Builder tagging(String tagging)

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

Parameters:

tagging - The tag-set for the object. The tag-set must be encoded as URL Query parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagging

CreateMultipartUploadRequest.Builder tagging(Tagging tagging)

objectLockMode

CreateMultipartUploadRequest.Builder objectLockMode(String objectLockMode)

Specifies the Object Lock mode that you want to apply to the uploaded object.

Parameters:

objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockMode, ObjectLockMode

objectLockMode

CreateMultipartUploadRequest.Builder objectLockMode(ObjectLockMode objectLockMode)

Specifies the Object Lock mode that you want to apply to the uploaded object.

Parameters:

objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockMode, ObjectLockMode

objectLockRetainUntilDate

CreateMultipartUploadRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

Specifies the date and time when you want the Object Lock to expire.

Parameters:

objectLockRetainUntilDate - Specifies the date and time when you want the Object Lock to expire.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectLockLegalHoldStatus

CreateMultipartUploadRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the uploaded object.

Parameters:

objectLockLegalHoldStatus - Specifies whether you want to apply a Legal Hold to the uploaded object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus

objectLockLegalHoldStatus

CreateMultipartUploadRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the uploaded object.

Parameters:

objectLockLegalHoldStatus - Specifies whether you want to apply a Legal Hold to the uploaded object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus

expectedBucketOwner

CreateMultipartUploadRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder