S3Aliases Class

Summary

Contains Cake aliases for configuring Amazon Simple Storage Service
Assembly
Cake.AWS.S3.dll
Namespace
Cake.AWS.S3
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["S3Aliases"] class Type type-node

Syntax

public static class S3Aliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
GenerateEncryptionKey(ICakeContext, FilePath) void
Generates a base64-encoded encryption key for Amazon S3 to use to encrypt / decrypt objects
static
GenerateEncryptionKey(ICakeContext, FilePath, int) void
Generates a base64-encoded encryption key for Amazon S3 to use to encrypt / decrypt objects
static
GetFileHash(ICakeContext, FilePath) string
Gets the hash of a file
static
GetPreSignedURL(ICakeContext, string, DateTime, S3Settings) string
Create a signed URL allowing access to a resource that would usually require authentication. cts
static
GetPreSignedURL(ICakeContext, string, string, DateTime, S3Settings) string
Create a signed URL allowing access to a resource that would usually require authentication. cts
static
GetS3Bytes(ICakeContext, string, DownloadSettings) Task<byte[]>
Get the byte array of a S3 object
static
GetS3Bytes(ICakeContext, string, string, DownloadSettings) Task<byte[]>
Get the byte array of a S3 object
static
GetS3Object(ICakeContext, string, S3Settings) Task<S3Object>
Retrieves object from Amazon S3.
static
GetS3Object(ICakeContext, string, string, S3Settings) Task<S3Object>
Retrieves object from Amazon S3.
static
GetS3Objects(ICakeContext, S3Settings) Task<IList<S3Object>>
Returns all the objects in a S3 bucket.
static
GetS3Objects(ICakeContext, string, S3Settings) Task<IList<S3Object>>
Returns all the objects in a S3 bucket.
static
GetS3String(ICakeContext, string, DownloadSettings) Task<string>
Get the string of a S3 object
static
GetS3String(ICakeContext, string, string, DownloadSettings) Task<string>
Get the string of a S3 object
static
S3Delete(ICakeContext, string, S3Settings) Task
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
static
S3Delete(ICakeContext, string, string, S3Settings) Task
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
static
S3DeleteAll(ICakeContext, S3Settings) Task<IList<string>>
Removes all objects from the bucket
static
S3DeleteAll(ICakeContext, string, DateTimeOffset, S3Settings) Task<IList<string>>
Removes all objects from the bucket
static
S3DeleteAll(ICakeContext, string, S3Settings) Task<IList<string>>
Removes all objects from the bucket
static
S3Download(ICakeContext, FilePath, string, DownloadSettings) Task
Downloads the content from Amazon S3 and writes it to the specified file.
static
S3Download(ICakeContext, FilePath, string, string, DownloadSettings) Task
Downloads the content from Amazon S3 and writes it to the specified file.
static
S3GetETag(ICakeContext, string, S3Settings) Task<string>
Gets the ETag of an S3 object
static
S3GetETag(ICakeContext, string, string, S3Settings) Task<string>
Gets the ETag of an S3 object
static
S3GetHashTag(ICakeContext, string, S3Settings) Task<string>
Gets the ETag of an S3 object
static
S3GetHashTag(ICakeContext, string, string, S3Settings) Task<string>
Gets the ETag of an S3 object
static
S3LastModified(ICakeContext, string, S3Settings) Task<DateTimeOffset>
Gets the last modified date of an S3 object
static
S3LastModified(ICakeContext, string, string, S3Settings) Task<DateTimeOffset>
Gets the last modified date of an S3 object
static
S3Open(ICakeContext, string, DownloadSettings) Task<Stream>
Opens a stream of the content from Amazon S3.
static
S3Open(ICakeContext, string, string, DownloadSettings) Task<Stream>
Opens a stream of the content from Amazon S3.
static
S3Sync(ICakeContext, DirectoryPath, SyncSettings) Task<IList<string>>
Syncs the specified directory to Amazon S3, checking the modified date of the local fiels with existing S3Objects.
static
S3SyncDownload(ICakeContext, DirectoryPath, SyncSettings) Task<IList<string>>
Syncs the specified directory from Amazon S3, checking the modified date of the local files with existing S3Objects and downloading them if its changed.
static
S3SyncDownload(ICakeContext, FilePath, SyncSettings) Task<string>
Syncs the specified file from Amazon S3, checking the modified date of the local file with a existing S3Object and downloads it if its changed.
static
S3SyncUpload(ICakeContext, DirectoryPath, SyncSettings) Task<IList<string>>
Syncs the specified directory to Amazon S3, checking the modified date of the local files with existing S3Objects and uploading them if its changes.
static
S3SyncUpload(ICakeContext, FilePath, SyncSettings) Task<string>
Syncs the specified file to Amazon S3, checking the modified date of the local file with a existing S3Object and uploads it if its changes.
static
S3Upload(ICakeContext, FilePath, string, UploadSettings) Task
Uploads the specified file. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3.
static
S3Upload(ICakeContext, Stream, string, UploadSettings) Task
Uploads the contents of the specified stream. For large uploads, the file will be divided and uploaded in parts using Amazon S3's multipart API. The parts will be reassembled as one object in Amazon S3.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin