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.

Request object for downloading a directory with the TransferUtility.

Inheritance Hierarchy

System.Object
  Amazon.S3.Transfer.TransferUtilityDownloadDirectoryRequest

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

Syntax

C#
public class TransferUtilityDownloadDirectoryRequest

The TransferUtilityDownloadDirectoryRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BucketName System.String

Gets or sets the name of the bucket.

Public Property DisableSlashCorrection System.Boolean

If this is set to true then the TransferUtility will not ensure the S3Directory property has a trailing / for a virtual S3 directory. The default value is false.

Public Property DownloadFilesConcurrently System.Boolean

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

Public Property LocalDirectory System.String

Gets or sets the local directory where objects from Amazon S3 will be downloaded. If the directory doesn't exist, it will be created.

Public Property ModifiedSinceDate System.DateTime

This property is deprecated. This property doesn't honor the DateTimeKind, please use ModifiedSinceDateUtc instead.

Gets or sets the ModifiedSinceDate property. Only objects that have been modified since this date will be downloaded.

Public Property ModifiedSinceDateUtc System.DateTime

Gets or sets the ModifiedSinceDateUtc property. Only objects that have been modified since this date will be downloaded.

Public Property S3Directory System.String

Gets or sets the Amazon S3 directory to download from. This is translated to a key prefix; keys that have this prefix will be downloaded. The TransferUtility will automatically add a / to the end when listing objects for to be downloaded. This treats S3Directory field as a virtual S3 directory. In some use cases the added / slash can be undesirable. To prevent the TransferUtility from adding the / at the end set the DisableSlashCorrection property to true.

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 decrypt 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 UnmodifiedSinceDate System.DateTime

This property is deprecated. This property doesn't honor the DateTimeKind, please use UnmodifiedSinceDateUtc instead.

Gets or sets the UnmodifiedSinceDate property. Only objects that have not been modified since this date will be downloaded.

Public Property UnmodifiedSinceDateUtc System.DateTime

Gets or sets the UnmodifiedSinceDateUtc property. Only objects that have not been modified since this date will be downloaded.

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