Class: Aws::S3::Types::CreateMultipartUploadRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::CreateMultipartUploadRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary collapse

#acl ⇒ String

The canned ACL to apply to the object.
#bucket ⇒ String

The name of the bucket where the multipart upload is initiated and where the object is uploaded.
#bucket_key_enabled ⇒ Boolean

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).
#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.
#checksum_algorithm ⇒ String

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object.
#content_disposition ⇒ String

Specifies presentational information for the object.
#content_encoding ⇒ String

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.
#content_language ⇒ String

The language that the content is in.
#content_type ⇒ String

A standard MIME type describing the format of the object data.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.
#expires ⇒ Time

The date and time at which the object is no longer cacheable.
#grant_full_control ⇒ String

Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
#grant_read ⇒ String

Specify access permissions explicitly to allow grantee to read the object data and its metadata.
#grant_read_acp ⇒ String

Specify access permissions explicitly to allows grantee to read the object ACL.
#grant_write_acp ⇒ String

Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
#key ⇒ String

Object key for which the multipart upload is to be initiated.
#metadata ⇒ Hash<String,String>

A map of metadata to store with the object in S3.
#object_lock_legal_hold_status ⇒ String

Specifies whether you want to apply a legal hold to the uploaded object.
#object_lock_mode ⇒ String

Specifies the Object Lock mode that you want to apply to the uploaded object.
#object_lock_retain_until_date ⇒ Time

Specifies the date and time when you want the Object Lock to expire.
#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request.
#server_side_encryption ⇒ String

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`).
#sse_customer_algorithm ⇒ String

Specifies the algorithm to use when encrypting the object (for example, AES256).
#sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
#sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321.
#ssekms_encryption_context ⇒ String

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
#ssekms_key_id ⇒ String

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.
#storage_class ⇒ String

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
#tagging ⇒ String

The tag-set for the object.
#website_redirect_location ⇒ String

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.

Instance Attribute Details

#acl ⇒ `String`

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.

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL [2]: docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#bucket ⇒ `String`

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-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format ` bucket-base-name–zone-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][2: in the *Amazon S3 User Guide*.

<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.

</note>

**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?][3: in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#bucket_key_enabled ⇒ `Boolean`

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

**General purpose buckets** - Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

**Directory buckets** - S3 Bucket Keys are always enabled for ‘GET` and `PUT` operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren’t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through [CopyObject], [UploadPartCopy], [the Copy operation in Batch Operations], or [the import jobs]. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops [4]: docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job

Returns:

(Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#cache_control ⇒ `String`

Specifies caching behavior along the request/reply chain.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_algorithm ⇒ `String`

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

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_disposition ⇒ `String`

Specifies presentational information for the object.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_encoding ⇒ `String`

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.

<note markdown=“1”> For directory buckets, only the ‘aws-chunked` value is supported in this header field.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_language ⇒ `String`

The language that the content is in.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#content_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#expected_bucket_owner ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#expires ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_full_control ⇒ `String`

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

<note markdown=“1”> 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.
```
</note>
```

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” `

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_read ⇒ `String`

Specify access permissions explicitly to allow grantee to read the object data and its metadata.

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

<note markdown=“1”> 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.
```
</note>
```

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” `

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_read_acp ⇒ `String`

Specify access permissions explicitly to allows grantee to read the object ACL.

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

<note markdown=“1”> 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.
```
</note>
```

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” `

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#grant_write_acp ⇒ `String`

Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

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

<note markdown=“1”> 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.
```
</note>
```

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” `

<note markdown=“1”> * This functionality is not supported for directory buckets.

This functionality is not supported for Amazon S3 on Outposts.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html [2]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#key ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#metadata ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_legal_hold_status ⇒ `String`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_mode ⇒ `String`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#object_lock_retain_until_date ⇒ `Time`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#request_payer ⇒ `String`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

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

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (‘AES256`) and server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We recommend that the bucket’s default encryption uses the desired encryption configuration and you don’t override the bucket default encryption in your ‘CreateSession` requests or `PUT` object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see

Protecting data with server-side encryption][1

in the *Amazon S3

User Guide*. For more information about the encryption overriding behaviors in directory buckets, see [Specifying server-side encryption with KMS for new object uploads].

In the Zonal endpoint API calls (except [CopyObject] and [UploadPartCopy]) using the REST API, the encryption request headers must match the encryption settings that are specified in the ‘CreateSession` request. You can’t override the values of the encryption settings (‘x-amz-server-side-encryption`, `x-amz-server-side-encryption-aws-kms-key-id`, `x-amz-server-side-encryption-context`, and `x-amz-server-side-encryption-bucket-key-enabled`) that are specified in the `CreateSession` request. You don’t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the ‘CreateSession` request to protect new objects in the directory bucket.

<note markdown=“1”> When you use the CLI or the Amazon Web Services SDKs, for ‘CreateSession`, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket’s default encryption configuration for the ‘CreateSession` request. It’s not supported to override the encryption settings values in the ‘CreateSession` request. So in the Zonal endpoint API calls (except

CopyObject][3

and [UploadPartCopy]), the encryption request

headers must match the default encryption configuration of the directory bucket.
```
</note>
```

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html [3]: docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html [4]: docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key ⇒ `String`

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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ `String`

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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_encryption_context ⇒ `String`

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

**Directory buckets** - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_key_id ⇒ `String`

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn’t exist in the same account that’s issuing the command, you must use the full Key ARN not the Key ID.

**General purpose buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify `x-amz-server-side-encryption:aws:kms` or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key (`aws/s3`) to protect the data.

**Directory buckets** - If you specify ‘x-amz-server-side-encryption` with `aws:kms`, the ` x-amz-server-side-encryption-aws-kms-key-id` header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that’s configured for your directory bucket’s default encryption setting. If you want to specify the ‘ x-amz-server-side-encryption-aws-kms-key-id` header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that’s configured for your directory bucket’s default encryption setting. Otherwise, you get an HTTP ‘400 Bad Request` error. Only use the key ID or key ARN. The key alias format of the KMS key isn’t supported. Your SSE-KMS configuration can only support 1 [customer managed key] per directory bucket for the lifetime of the bucket. The [Amazon Web Services managed key] (‘aws/s3`) isn’t supported.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#storage_class ⇒ `String`

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][1: in the *Amazon S3 User Guide*.

<note markdown=“1”> * 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.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#tagging ⇒ `String`

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#website_redirect_location ⇒ `String`

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.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 3485

class CreateMultipartUploadRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :checksum_algorithm)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

Class: Aws::S3::Types::CreateMultipartUploadRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

#bucket ⇒ String

#bucket_key_enabled ⇒ Boolean

#cache_control ⇒ String

#checksum_algorithm ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_type ⇒ String

#expected_bucket_owner ⇒ String

#expires ⇒ Time

#grant_full_control ⇒ String

#grant_read ⇒ String

#grant_read_acp ⇒ String

#grant_write_acp ⇒ String

#key ⇒ String

#metadata ⇒ Hash<String,String>

#object_lock_legal_hold_status ⇒ String

#object_lock_mode ⇒ String

#object_lock_retain_until_date ⇒ Time

#request_payer ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_encryption_context ⇒ String

#ssekms_key_id ⇒ String

#storage_class ⇒ String

#tagging ⇒ String

#website_redirect_location ⇒ String

#acl ⇒ `String`

#bucket ⇒ `String`

#bucket_key_enabled ⇒ `Boolean`

#cache_control ⇒ `String`

#checksum_algorithm ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_type ⇒ `String`

#expected_bucket_owner ⇒ `String`

#expires ⇒ `Time`

#grant_full_control ⇒ `String`

#grant_read ⇒ `String`

#grant_read_acp ⇒ `String`

#grant_write_acp ⇒ `String`

#key ⇒ `String`

#metadata ⇒ `Hash<String,String>`

#object_lock_legal_hold_status ⇒ `String`

#object_lock_mode ⇒ `String`

#object_lock_retain_until_date ⇒ `Time`

#request_payer ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_encryption_context ⇒ `String`

#ssekms_key_id ⇒ `String`

#storage_class ⇒ `String`

#tagging ⇒ `String`

#website_redirect_location ⇒ `String`