Plinth.Storage.AWS 1.5.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0
dotnet add package Plinth.Storage.AWS --version 1.5.0
NuGet\Install-Package Plinth.Storage.AWS -Version 1.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Plinth.Storage.AWS" Version="1.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Plinth.Storage.AWS --version 1.5.0
#r "nuget: Plinth.Storage.AWS, 1.5.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Plinth.Storage.AWS as a Cake Addin
#addin nuget:?package=Plinth.Storage.AWS&version=1.5.0

// Install Plinth.Storage.AWS as a Cake Tool
#tool nuget:?package=Plinth.Storage.AWS&version=1.5.0

README

Plinth.Storage.AWS

Storage Provider for Plinth.Storage to write blob data to AWS S3

Enables storing the blob data used by Plinth.Storage in AWS S3

This package adds these extension methods to Plinth.Storage.StorageFactory to utilize S3

    storageFactory.AddS3Provider(new S3Settings()
      {
          BucketName = "my-s3-bucket",
          S3Url = "https://s3.us-west-1.amazonaws.com",
          ClientId = "{aws-client-id}",
          ClientSecret = "{aws-client-secret}"
      });

    storageFactory.SetDefaultWriteProviderAsS3();

Index Strategies

By default, this will write blobs to the root of the container. There are 2 other built in options for further segmenting the blobs. To use these, set DefaultIndexStrategy in S3Settings

DefaultIndexStrategy.ByDate This will place the blobs in a sub folder with the current date as /YY/MM/DD/{blobId}

DefaultIndexStrategy.ByDateTime This will place the blobs in a sub folder with the current date and current hour as /YY/MM/DD/HH/{blobId}

Alternatively, a custom indexing strategy can be provided. For example, the below will place the blobs under a folder named the first character of the blob's guid.

      new S3Settings()
      {
          ...
          CustomIndexStrategy = blob => $"{blob.Guid!.ToString()![0]}"
      }

Backup Bucket

By default, blobs will be written to the bucket specified. This library supports writing a backup to other buckets

To enable, use storageFactory.AddBackupS3Provider(settings) with a complete S3Settings object. Blobs will be written to the bucket specified (using the primary index).

IAM Authentication

If you prefer not to supply the ClientId/ClientSecret but instead use the IAM authentication available on AWS infrastructure, set UseSystemAuth to true in S3Settings instead.

File Extensions

By default, the blobs will a file extension in blob storage which come from the blob name field. This allows for browsers to more easily download those files directly. To disable this, set DisableBlobExtensions to true in S3Settings and the blobs will not have a file extension.

Public Access

By default, S3 blobs are private and require authentication to access. If anonymous access to the files is desired, set AllowPublicRead to true in S3Settings to enable Public Read access to the blobs. You must also enable public access at the bucket level for this to work.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.0 84 11/9/2022
1.5.0-b88.7a7c20cd 31 11/9/2022
1.4.7 142 10/20/2022
1.4.6 265 10/17/2022
1.4.5 163 10/1/2022
1.4.4 259 8/16/2022
1.4.3 152 8/2/2022
1.4.2 180 7/19/2022
1.4.2-b80.7fdbfd04 71 7/19/2022
1.4.2-b74.acaf86f5 62 6/15/2022
1.4.1 177 6/13/2022
1.4.0 170 6/6/2022
1.3.8 559 4/12/2022
1.3.7 183 3/21/2022
1.3.6 180 3/17/2022
1.3.6-b67.ca5053f3 69 3/16/2022
1.3.6-b66.4a9683e6 62 3/16/2022
1.3.5 182 2/23/2022
1.3.4 256 1/20/2022
1.3.3 238 12/29/2021
1.3.2 323 12/11/2021
1.3.1 195 11/12/2021
1.3.0 197 11/8/2021
1.2.3 1,361 9/22/2021
1.2.2 236 8/20/2021
1.2.1 233 8/5/2021
1.2.0 259 8/1/2021
1.2.0-b37.a54030b9 104 6/24/2021
1.1.6 283 3/22/2021
1.1.5 215 3/9/2021
1.1.4 281 2/27/2021
1.1.3 234 2/17/2021
1.1.2 216 2/12/2021
1.1.1 555 2/1/2021
1.1.0 312 12/16/2020
1.1.0-b27.b66c309b 229 11/15/2020
1.0.12 375 10/18/2020
1.0.11 319 10/6/2020
1.0.10 284 9/30/2020
1.0.9 275 9/29/2020
1.0.8 476 9/26/2020
1.0.7 445 9/19/2020
1.0.6 353 9/3/2020
1.0.5 534 9/2/2020
1.0.4 524 9/1/2020
1.0.3 375 9/1/2020
1.0.2 380 8/29/2020
1.0.1 372 8/29/2020
1.0.0 366 8/29/2020
1.0.0-b1.c22f563d 196 8/28/2020

net7.0 support and removed netcoreapp3.1