Builder

class Builder

Properties

Link copied to clipboard

The canned access control list (ACL) to apply to the object.

Link copied to clipboard

The name of the destination bucket.

Link copied to clipboard

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). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

Link copied to clipboard

Specifies the caching behavior along the request/reply chain.

Link copied to clipboard

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.

Link copied to clipboard

Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

Link copied to clipboard

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.

Link copied to clipboard

The language the content is in.

Link copied to clipboard

A standard MIME type that describes the format of the object data.

Link copied to clipboard

Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

Link copied to clipboard

Copies the object if its entity tag (ETag) matches the specified tag.

Link copied to clipboard

Copies the object if it has been modified since the specified time.

Link copied to clipboard

Copies the object if its entity tag (ETag) is different than the specified ETag.

Link copied to clipboard

Copies the object if it hasn't been modified since the specified time.

Link copied to clipboard

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

Link copied to clipboard

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be the same one that was used when the source object was created.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Allows grantee to read the object data and its metadata.

Link copied to clipboard

Allows grantee to read the object ACL.

Link copied to clipboard

Allows grantee to write the ACL for the applicable object.

Link copied to clipboard
var key: String?

The key of the destination object.

Link copied to clipboard

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

Link copied to clipboard

Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY is the default behavior.

Link copied to clipboard

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

Link copied to clipboard

The Object Lock mode that you want to apply to the object copy.

Link copied to clipboard

The date and time when you want the Object Lock of the object copy to expire.

Link copied to clipboard

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

Link copied to clipboard

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Link copied to clipboard

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) 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.

Link copied to clipboard

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

Link copied to clipboard

The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

Link copied to clipboard

Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.

Link copied to clipboard

If the destination bucket is configured as a website, redirects requests for this object copy 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 value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.