CommonNetFuncs.Web.Aws.S3 4.0.43

CommonNetFuncs.Web.Aws.S3

This lightweight project contains helper methods for several common functions required by applications.

Contents

• CommonNetFuncs.Web.Aws.S3
  • Contents
  • AwsS3HelpersStatic / ApiAwsS3
    • AwsS3 Usage Examples
      • UploadS3File
      • GetS3File
      • DeleteS3File
      • S3FileExists
      • GetAllS3BucketFiles
      • GetS3Url
  • Installation
  • License

AwsS3HelpersStatic / ApiAwsS3

Provides helpers for uploading, downloading, deleting, and querying files in Amazon S3 buckets. AwsS3HelpersStatic exposes all operations as IAmazonS3 extension methods for direct use. ApiAwsS3 wraps the same helpers behind an IAwsS3 interface for dependency-injection scenarios. Large uploads (> 10 MB by default) are automatically routed through multipart upload. Download streams can be optionally decompressed on the fly. Bucket existence is validated and cached per-request to avoid redundant AWS calls.

AwsS3 Usage Examples

<details> <summary><h3>Usage Examples</h3></summary>

UploadS3File

Upload a stream to S3, optionally compressing it with gzip or deflate before transfer.

using CommonNetFuncs.Web.Aws.S3;

// DI: inject IAwsS3 (backed by ApiAwsS3)
bool success = await _s3.UploadS3File(
    bucketName: "my-bucket",
    fileName: "reports/report.json",
    fileData: jsonStream,
    compressSteam: true,
    compressionType: ECompressionType.Gzip
);

// Static: use IAmazonS3 directly
bool success = await amazonS3Client.UploadS3File("my-bucket", "file.bin", fileStream);

GetS3File

Download an S3 object into an existing stream, optionally decompressing gzip content automatically.

using MemoryStream ms = new();
await _s3.GetS3File("my-bucket", "reports/report.json", ms, decompressGzipData: true);

DeleteS3File

bool deleted = await _s3.DeleteS3File("my-bucket", "reports/old-report.json");

S3FileExists

bool exists = await _s3.S3FileExists("my-bucket", "reports/report.json");

GetAllS3BucketFiles

Returns all object keys in a bucket, paginating automatically.

List<string>? keys = await _s3.GetAllS3BucketFiles("my-bucket", maxKeysPerQuery: 1000);

GetS3Url

Returns the public URL for an object if the bucket is publicly accessible.

string? url = await _s3.GetS3Url("my-bucket", "reports/report.json");

</details>

Installation

Install via NuGet:

dotnet add package CommonNetFuncs.Web.Aws.S3

License

This project is licensed under the MIT License - see the LICENSE file for details.