AWS SDK Version 3 for .NET
API Reference

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.

Contains all the parameters that can be set when making a this request with the TransferUtility method.

Inheritance Hierarchy

System.Object
  Amazon.S3.Transfer.BaseUploadRequest
    Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest

Namespace: Amazon.S3.Transfer
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public class TransferUtilityUploadDirectoryRequest : BaseUploadRequest

The TransferUtilityUploadDirectoryRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BucketName System.String

Gets or sets the name of the bucket.

Public Property CalculateContentMD5Header System.Boolean

Gets or sets whether the Content-MD5 header should be calculated for upload.

Public Property CannedACL Amazon.S3.S3CannedACL

Gets or sets the canned access control list (ACL) for the uploaded objects. Please refer to Amazon.S3.S3CannedACL for information on Amazon S3 canned ACLs.

Public Property ContentType System.String

Gets or sets the content type for the uploaded Amazon S3 objects. The default behavior when this field is not set is to use the file extension to set the content type. If this field is set to a value it will be applied to all uploaded files in the directory, overriding file extension inspection.

Public Property Directory System.String

Gets or sets the directory where files are uploaded from.

Public Property DisablePayloadSigning System.Boolean

Gets or sets whether the payload should be signed or not

Public Property KeyPrefix System.String

Gets or sets the KeyPrefix property. As object keys are generated for the files being uploaded this value will prefix the key. This is useful when a directory needs to be uploaded into sub directory in the S3 Bucket.

Public Property Metadata Amazon.S3.Model.MetadataCollection

The collection of meta data for the request.

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

Public Property ObjectLockMode Amazon.S3.ObjectLockMode

Gets and sets the property ObjectLockMode.

The Object Lock mode that you want to apply to this object.

Public Property ObjectLockRetainUntilDate System.DateTime

Gets and sets the property ObjectLockRetainUntilDate.

The date and time when you want this object's Object Lock to expire.

Public Property SearchOption System.IO.SearchOption

Gets or sets the recursive options for the directory upload.

Public Property SearchPattern System.String

Gets and sets the search pattern used to determine which files in the directory are uploaded.

Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod

The Server-side encryption algorithm to be used with the customer provided key.

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

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

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

Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod

Gets or sets the ServerSideEncryptionMethod property. Specifies the encryption used on the server to store the content.

Public Property StorageClass Amazon.S3.S3StorageClass

Gets or sets the storage class for the uploaded Amazon S3 objects. Please refer to Amazon.S3.S3StorageClass for information on S3 Storage Classes.

Public Property TagSet System.Collections.Generic.List<Amazon.S3.Model.Tag>

Tags that will be applied to all objects in the diretory.

Public Property UploadFilesConcurrently System.Boolean

Gets or sets the UploadFilesConcurrently property. Specifies if multiple files will be uploaded concurrently. The number of concurrent web requests used is controlled by the TransferUtilityConfig.ConcurrencyLevel property.

Events

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5