Package 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 Details

    • acl

      CreateMultipartUploadRequest.Builder acl(String acl)

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

      Parameters:
      acl - 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 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. 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.

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

    • acl

      CreateMultipartUploadRequest.Builder acl(ObjectCannedACL acl)

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

      Parameters:
      acl - 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 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. 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.

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

    • bucket

      CreateMultipartUploadRequest.Builder bucket(String bucket)

      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-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules 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 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? in the Amazon S3 User Guide.

      Parameters:
      bucket - 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-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules 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 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? 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.

      For directory buckets, only the aws-chunked value is supported in this 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.

      For directory buckets, only the aws-chunked value is supported in this 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 that the content is in.

      Parameters:
      contentLanguage - The language that 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)

      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 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 account

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

      Parameters:
      grantFullControl - 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 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 account

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

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

    • grantRead

      CreateMultipartUploadRequest.Builder grantRead(String grantRead)

      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 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 account

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

      Parameters:
      grantRead - 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 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 account

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

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

    • grantReadACP

      CreateMultipartUploadRequest.Builder grantReadACP(String grantReadACP)

      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 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 account

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

      Parameters:
      grantReadACP - 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 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 account

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

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

    • grantWriteACP

      CreateMultipartUploadRequest.Builder grantWriteACP(String grantWriteACP)

      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 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 account

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

      Parameters:
      grantWriteACP - 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 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 account

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

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

      Parameters:
      serverSideEncryption - 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.

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

    • serverSideEncryption

      CreateMultipartUploadRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

      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.

      Parameters:
      serverSideEncryption - 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.

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

    • 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. For more information, see Storage Classes 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.

      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. For more information, see Storage Classes 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.

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

    • 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. For more information, see Storage Classes 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.

      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. For more information, see Storage Classes 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.

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

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

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

      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 when encrypting the object (for example, AES256).

      This functionality is not supported for directory buckets.

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

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

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

      Parameters:
      sseCustomerKeyMD5 - 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.

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

    • ssekmsKeyId

      CreateMultipartUploadRequest.Builder ssekmsKeyId(String ssekmsKeyId)

      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.

      Parameters:
      ssekmsKeyId - 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.

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

    • ssekmsEncryptionContext

      CreateMultipartUploadRequest.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)

      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.

      Parameters:
      ssekmsEncryptionContext - 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.

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

      Parameters:
      bucketKeyEnabled - 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.

      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

      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:

    • tagging

      CreateMultipartUploadRequest.Builder tagging(String tagging)

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

      This functionality is not supported for directory buckets.

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

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

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

      This functionality is not supported for directory buckets.

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

    • objectLockMode

      CreateMultipartUploadRequest.Builder objectLockMode(ObjectLockMode objectLockMode)

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

      This functionality is not supported for directory buckets.

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

      This functionality is not supported for directory buckets.

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

    • objectLockRetainUntilDate

      CreateMultipartUploadRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

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

      This functionality is not supported for directory buckets.

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

      This functionality is not supported for directory buckets.

      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.

      This functionality is not supported for directory buckets.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object.

      This functionality is not supported for directory buckets.

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

    • objectLockLegalHoldStatus

      CreateMultipartUploadRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

      Specifies whether you want to apply a legal hold to the uploaded object.

      This functionality is not supported for directory buckets.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object.

      This functionality is not supported for directory buckets.

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

    • expectedBucketOwner

      CreateMultipartUploadRequest.Builder expectedBucketOwner(String expectedBucketOwner)

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

      Parameters:
      expectedBucketOwner - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumAlgorithm

      CreateMultipartUploadRequest.Builder checksumAlgorithm(String checksumAlgorithm)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumAlgorithm

      CreateMultipartUploadRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.