AWS SDK Version 4 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

NameDescription
Public Method TransferUtilityUploadDirectoryRequest()

Properties

NameTypeDescription
Public Property BucketKeyEnabled System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property BucketName System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property CannedACL Amazon.S3.S3CannedACL Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ChecksumAlgorithm Amazon.S3.ChecksumAlgorithm Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ContentType System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property Directory System.String

Gets or sets the directory where files are uploaded from.

Public Property DisableDefaultChecksumValidation System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property DisablePayloadSigning System.Nullable<System.Boolean> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ExpectedBucketOwner System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property Grants System.Collections.Generic.List<Amazon.S3.Model.S3Grant> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property Headers Amazon.S3.Model.HeadersCollection Inherited from Amazon.S3.Transfer.BaseUploadRequest.
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 Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ObjectLockLegalHoldStatus Amazon.S3.ObjectLockLegalHoldStatus Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ObjectLockMode Amazon.S3.ObjectLockMode Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ObjectLockRetainUntilDate System.Nullable<System.DateTime> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property RequestPayer Amazon.S3.RequestPayer Inherited from Amazon.S3.Transfer.BaseUploadRequest.
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 Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionCustomerProvidedKey System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionCustomerProvidedKeyMD5 System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionKeyManagementServiceKeyId System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property SSEKMSEncryptionContext System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property StorageClass Amazon.S3.S3StorageClass Inherited from Amazon.S3.Transfer.BaseUploadRequest.
Public Property TagSet System.Collections.Generic.List<Amazon.S3.Model.Tag> Inherited from Amazon.S3.Transfer.BaseUploadRequest.
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.

Public Property WebsiteRedirectLocation System.String Inherited from Amazon.S3.Transfer.BaseUploadRequest.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method RemoveCannedACL() Inherited from Amazon.S3.Transfer.BaseUploadRequest.

Events

NameDescription
Event UploadDirectoryFileRequestEvent
Event UploadDirectoryProgressEvent

Version Information

.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