Genbox.SimpleS3.Cli 1.0.0

SimpleS3

Description

A C# implementation of Amazon's S3 API with a focus on simplicity, security and performance. Download or upload an object with a single line of code.

S3 features

• Streaming chunked encoding support.
• Server-side encryption with customer keys.
• Support for path and virtual host style buckets.
• Support for pre-signed URLs.

API features

Features provided by SimpleS3:

• Retry/timeout support via Polly.
• Build requests through easy builder-based APIs. You never again have to remember the low-level details of a HTTP header.
• Use the ProfileManager to manage credentials securely with in-memory encryption.
• Full async and cancellation support.
• Client-side validation of requests makes it easier to know what is wrong before sending a request.
• Support uploading non-seekable streams or streams with no length.
• Supports automatic URL decoding of XML responses to support special non-XML compliant characters.
• Extensive unit tests ensure correctness and stability.
• Few allocations due to extensive use of object pools.
• API is fully annotated with nullability.
• Dependency injection friendly. By default uses Microsoft.Extensions.DependencyInjection.
• Supports configuration binding via Microsoft.Extensions.Configuration.
• Support multiple S3 providers. See provider support further down for more info.
• Support for uploading/downloading multiparts with parallel requests.
• High-level API to help listing/deleting more than 1000 objects at the time. Uses HTTP pipelining to reduce latency.
• Automatic pooling of requests to reduce allocations and speed up requests.

Usage

Download packages

See the provider status page for the list of operations that are currently supported. For the purpose of the examples below, we are going to use the Amazon S3 provider.

Setup the config and client

AmazonS3Client client = new AmazonS3Client("MyKeyId", "MyAccessKey", AmazonS3Region.EuWest1)

Or use Microsoft's Dependency Injection

ServiceCollection services = new ServiceCollection();
services.AddAmazonS3(config => {
    config.Credentials = new StringAccessKey("MyKeyId", "MyAccessKey");
    config.Region = AmazonS3Region.EuWest1;
});

ServiceProvider provider = services.BuildServiceProvider();
AmazonS3Client client = provider.GetRequiredService<AmazonS3Client>();

Download/Upload using the Transfer API

The fluent Transfer API makes downloading/uploading objects easier by providing a convenient way of supplying information such as cache control, content-disposition, encryption keys, etc.

//Upload
IUpload upload = client.CreateUpload("MyBucket", "MyObject")
                        .WithAccessControl(ObjectCannedAcl.PublicReadWrite)
                        .WithCacheControl(CacheControlType.NoCache)
                        .WithEncryption();

PutObjectResponse putResp = await upload.UploadStringAsync("Hello World!");

//Download string
IDownload download = client.CreateDownload(bucketName, objectName)
                           .WithRange(0, 5);

GetObjectResponse getResp = await download.DownloadAsync();

Console.WriteLine(await dlResp.Content.AsStringAsync()); //Outputs "Hello"

Extensions

SimpleS3 is extensible and has multiple different network drivers and extensions you can use. Click on the extension below for more information.

If you are already using the SimpleS3.AmazonS3 package, you already have a dependency on most of the extensions below. These are only for advanced users that want to tweak their setup to their own liking.

Nuget	Extension	Description
	HttpClient	A network driver based on HttpClient
	HttpClientFactory	A network driver based on HttpClientFactory. It supports dynamic DNS changes.
	HttpClientFactory.Polly	Adds support for retry/timeout logic through Polly
	ProfileManager	A profile manager that can safely persist your credentials to disk