AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
The base class TransferUtility request classes.
Namespace: Amazon.S3.Transfer
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
public abstract class BaseUploadRequest
The BaseUploadRequest type exposes the following members
| Name | Type | Description | |
|---|---|---|---|
|
BucketKeyEnabled | System.Nullable<System.Boolean> |
Gets and sets the property 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). General purpose buckets - Setting this header to Directory buckets - S3 Bucket Keys are always enabled for |
|
BucketName | System.String |
Gets or sets the name of the bucket. |
|
CannedACL | Amazon.S3.S3CannedACL |
Gets or sets the canned access control list (ACL) for the uploaded object. Please refer to Amazon.S3.S3CannedACL for information on Amazon S3 canned ACLs. |
|
ChecksumAlgorithm | Amazon.S3.ChecksumAlgorithm |
Gets and sets the property ChecksumAlgorithm. Indicates the algorithm used to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 will ignore any provided |
|
ContentType | System.String |
Gets or sets the content type of the uploaded Amazon S3 object.
This is a convenience property for Headers.ContentType.
|
|
DisableDefaultChecksumValidation | System.Nullable<System.Boolean> |
WARNING: Setting DisableDefaultChecksumValidation to true disables the default data integrity check on upload requests. When true, checksum verification will not be used in upload requests. This may increase upload performance under high CPU loads. Setting DisableDefaultChecksumValidation sets the deprecated property DisableMD5Stream to the same value. The default value is false. Checksums, SigV4 payload signing, and HTTPS each provide some data integrity verification. If DisableDefaultChecksumValidation is true and DisablePayloadSigning is true, then the possibility of data corruption is completely dependent on HTTPS being the only remaining source of data integrity verification. |
|
DisablePayloadSigning | System.Nullable<System.Boolean> |
WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing data integrity check on this request. If using SigV4, the DisablePayloadSigning flag controls if the payload should be signed on a request by request basis. By default this flag is null which will use the default client behavior. The default client behavior is to sign the payload. When DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS connection. Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may be desirable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies to Amazon S3 PutObject and UploadPart requests. MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the possibility of data corruption is completely dependent on HTTPS being the only remaining source of data integrity verification. |
|
ExpectedBucketOwner | System.String |
Gets and sets the property 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 |
|
Grants | System.Collections.Generic.List<Amazon.S3.Model.S3Grant> |
Gets the access control lists (ACLs) for this request. Please refer to Amazon.S3.Model.S3Grant for information on S3 Grants. |
|
Headers | Amazon.S3.Model.HeadersCollection |
The collection of headers for the request. |
|
Metadata | Amazon.S3.Model.MetadataCollection |
The collection of meta data for the request. |
|
ObjectLockLegalHoldStatus | Amazon.S3.ObjectLockLegalHoldStatus |
Gets and sets the property ObjectLockLegalHoldStatus. Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock. |
|
ObjectLockMode | Amazon.S3.ObjectLockMode |
Gets and sets the property ObjectLockMode. The Object Lock mode that you want to apply to this object. |
|
ObjectLockRetainUntilDate | System.Nullable<System.DateTime> |
Gets and sets the property ObjectLockRetainUntilDate. The date and time when you want this object's Object Lock to expire. |
|
RequestPayer | Amazon.S3.RequestPayer |
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. |
|
ServerSideEncryptionCustomerMethod | Amazon.S3.ServerSideEncryptionCustomerMethod |
The Server-side encryption algorithm to be used with the customer provided key. |
|
ServerSideEncryptionCustomerProvidedKey | System.String |
The Base64 encoded encryption key for Amazon S3 to use to encrypt the object Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide. When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you. Important: Amazon S3 does not store the encryption key you provide. |
|
ServerSideEncryptionCustomerProvidedKeyMD5 | System.String |
The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. |
|
ServerSideEncryptionKeyManagementServiceKeyId | System.String |
The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. |
|
ServerSideEncryptionMethod | Amazon.S3.ServerSideEncryptionMethod |
Gets and sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content. |
|
SSEKMSEncryptionContext | System.String |
Gets and sets the property SSEKMSEncryptionContext.
Specifies the Amazon Web Services KMS Encryption Context as
an additional 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.
This value is stored as object metadata and automatically gets passed on to
Amazon Web Services KMS for future General purpose buckets
- This value must be explicitly added during 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. |
|
StorageClass | Amazon.S3.S3StorageClass |
Gets or sets the storage class for the uploaded Amazon S3 object. Please refer to Amazon.S3.S3StorageClass for information on S3 Storage Classes. |
|
TagSet | System.Collections.Generic.List<Amazon.S3.Model.Tag> |
The tag-set for the object. |
|
WebsiteRedirectLocation | System.String |
Gets and sets the property 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. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide. In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
In the following example, the request header sets the object redirect to another website:
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects in the Amazon S3 User Guide. This functionality is not supported for directory buckets. |
| Name | Description | |
|---|---|---|
|
RemoveCannedACL() |
Removes the canned access control list (ACL) for the uploaded object. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer