Package software.amazon.awssdk.services.s3.model

Class CreateMultipartUploadRequest

    • Method Detail

      • acl

        public final ObjectCannedACL acl()

        The canned ACL to apply to the object.

        This action is not supported by Amazon S3 on Outposts.

        If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().

        Returns:
        The canned ACL to apply to the object.

        This action is not supported by Amazon S3 on Outposts.

        See Also:
        ObjectCannedACL

      • aclAsString

        public final String aclAsString()

        The canned ACL to apply to the object.

        This action is not supported by Amazon S3 on Outposts.

        If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().

        Returns:
        The canned ACL to apply to the object.

        This action is not supported by Amazon S3 on Outposts.

        See Also:
        ObjectCannedACL

      • bucket

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

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

        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.

      • cacheControl

        public final String cacheControl()

        Specifies caching behavior along the request/reply chain.

        Returns:
        Specifies caching behavior along the request/reply chain.

      • contentDisposition

        public final String contentDisposition()

        Specifies presentational information for the object.

        Returns:
        Specifies presentational information for the object.

      • contentEncoding

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

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

      • contentLanguage

        public final String contentLanguage()

        The language the content is in.

        Returns:
        The language the content is in.

      • contentType

        public final String contentType()

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

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

      • expires

        public final Instant expires()

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

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

      • grantFullControl

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

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

        This action is not supported by Amazon S3 on Outposts.

      • grantRead

        public final String grantRead()

        Allows grantee to read the object data and its metadata.

        This action is not supported by Amazon S3 on Outposts.

        Returns:
        Allows grantee to read the object data and its metadata.

        This action is not supported by Amazon S3 on Outposts.

      • grantReadACP

        public final String grantReadACP()

        Allows grantee to read the object ACL.

        This action is not supported by Amazon S3 on Outposts.

        Returns:
        Allows grantee to read the object ACL.

        This action is not supported by Amazon S3 on Outposts.

      • grantWriteACP

        public final String grantWriteACP()

        Allows grantee to write the ACL for the applicable object.

        This action is not supported by Amazon S3 on Outposts.

        Returns:
        Allows grantee to write the ACL for the applicable object.

        This action is not supported by Amazon S3 on Outposts.

      • key

        public final String key()

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

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

      • hasMetadata

        public final boolean hasMetadata()
        For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metadata

        public final Map<String,​String> metadata()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadata() method.

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

      • serverSideEncryptionAsString

        public final String serverSideEncryptionAsString()

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

        If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionAsString().

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

      • storageClass

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

        If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

        Returns:
        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.
        See Also:
        StorageClass

      • storageClassAsString

        public final String storageClassAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

        Returns:
        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.
        See Also:
        StorageClass

      • websiteRedirectLocation

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

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

      • sseCustomerAlgorithm

        public final String sseCustomerAlgorithm()

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

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

      • sseCustomerKey

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

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

      • sseCustomerKeyMD5

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

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

      • ssekmsKeyId

        public final String ssekmsKeyId()

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

        Returns:
        Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

      • ssekmsEncryptionContext

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

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

      • bucketKeyEnabled

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

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

      • requestPayerAsString

        public final String requestPayerAsString()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer

      • tagging

        public final String tagging()

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

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

      • objectLockModeAsString

        public final String objectLockModeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, objectLockMode will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().

        Returns:
        Specifies the Object Lock mode that you want to apply to the uploaded object.
        See Also:
        ObjectLockMode

      • objectLockRetainUntilDate

        public final Instant objectLockRetainUntilDate()

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

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

      • expectedBucketOwner

        public final String expectedBucketOwner()

        The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

        Returns:
        The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object