This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AWS.S3.
Summary
Downloads the content from Amazon S3 and writes it to the specified file.
- Assembly
- Cake
.AWS .S3 .dll - Namespace
- Cake
.AWS .S3 - Containing Type
- IS3Manager
Syntax
Task Download(FilePath filePath, string key, string version, DownloadSettings settings, CancellationToken cancellationToken = null)Parameters
| Name | Type | Description |
|---|---|---|
| filePath | FilePath | The file path of the file to upload. |
| key | string | The key under which the Amazon S3 object is stored. |
| version | string | The identifier for the specific version of the object to be downloaded, if required. |
| settings | DownloadSettings | The DownloadSettings required to download from Amazon S3. |
| cancellationToken | CancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
| Type | Description |
|---|---|
| Task |