Cake.AWS.S3

AWS S3 addin for Cake.

#addin nuget:?package=Cake.AWS.S3&version=0.6.9

<package id="Cake.AWS.S3" version="0.6.9" />

dotnet add package Cake.AWS.S3 --version 0.6.9

<PackageReference Include="Cake.AWS.S3" Version="0.6.9" />

Aliases

Contains Cake aliases for configuring Amazon Simple Storage Service

S3

CreateDownloadSettings(ICakeContext) Helper method to get the AWS Credentials from environment variables
CreateSyncSettings(ICakeContext) Helper method to get the AWS Credentials from environment variables
CreateUploadSettings(ICakeContext) Helper method to get the AWS Credentials from environment variables
GenerateEncryptionKey(ICakeContext, FilePath) Generates a base64-encoded encryption key for Amazon S3 to use to encrypt / decrypt objects
GenerateEncryptionKey(ICakeContext, FilePath, int) Generates a base64-encoded encryption key for Amazon S3 to use to encrypt / decrypt objects
GetFileHash(ICakeContext, FilePath) Gets the hash of a file
GetPreSignedURL(ICakeContext, string, DateTime, S3Settings) Create a signed URL allowing access to a resource that would usually require authentication. cts
GetPreSignedURL(ICakeContext, string, string, DateTime, S3Settings) Create a signed URL allowing access to a resource that would usually require authentication. cts
GetS3Bytes(ICakeContext, string, DownloadSettings) Get the byte array of a S3 object
GetS3Bytes(ICakeContext, string, string, DownloadSettings) Get the byte array of a S3 object
GetS3Object(ICakeContext, string, S3Settings) Retrieves object from Amazon S3.
GetS3Object(ICakeContext, string, string, S3Settings) Retrieves object from Amazon S3.
GetS3Objects(ICakeContext, S3Settings) Returns all the objects in a S3 bucket.
GetS3Objects(ICakeContext, string, S3Settings) Returns all the objects in a S3 bucket.
GetS3String(ICakeContext, string, DownloadSettings) Get the string of a S3 object
GetS3String(ICakeContext, string, string, DownloadSettings) Get the string of a S3 object
S3Delete(ICakeContext, string, S3Settings) 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.
S3Delete(ICakeContext, string, string, S3Settings) 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.
S3DeleteAll(ICakeContext, S3Settings) Removes all objects from the bucket
S3DeleteAll(ICakeContext, string, DateTimeOffset, S3Settings) Removes all objects from the bucket
S3DeleteAll(ICakeContext, string, S3Settings) Removes all objects from the bucket
S3Download(ICakeContext, FilePath, string, DownloadSettings) Downloads the content from Amazon S3 and writes it to the specified file.
S3Download(ICakeContext, FilePath, string, string, DownloadSettings) Downloads the content from Amazon S3 and writes it to the specified file.
S3GetETag(ICakeContext, string, S3Settings) Gets the ETag of an S3 object
S3GetETag(ICakeContext, string, string, S3Settings) Gets the ETag of an S3 object
S3GetHashTag(ICakeContext, string, S3Settings) Gets the ETag of an S3 object
S3GetHashTag(ICakeContext, string, string, S3Settings) Gets the ETag of an S3 object
S3LastModified(ICakeContext, string, S3Settings) Gets the last modified date of an S3 object
S3LastModified(ICakeContext, string, string, S3Settings) Gets the last modified date of an S3 object
S3Open(ICakeContext, string, DownloadSettings) Opens a stream of the content from Amazon S3.
S3Open(ICakeContext, string, string, DownloadSettings) Opens a stream of the content from Amazon S3.
S3Sync(ICakeContext, DirectoryPath, SyncSettings) Syncs the specified directory to Amazon S3, checking the modified date of the local fiels with existing S3Objects.
S3SyncDownload(ICakeContext, DirectoryPath, SyncSettings) Syncs the specified directory from Amazon S3, checking the modified date of the local files with existing S3Objects and downloading them if its changed.
S3SyncDownload(ICakeContext, FilePath, SyncSettings) 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.
S3SyncUpload(ICakeContext, DirectoryPath, SyncSettings) Syncs the specified directory to Amazon S3, checking the modified date of the local files with existing S3Objects and uploading them if its changes.
S3SyncUpload(ICakeContext, FilePath, SyncSettings) 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.
S3Upload(ICakeContext, FilePath, string, UploadSettings) 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.
S3Upload(ICakeContext, Stream, string, UploadSettings) 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.