Class AmazonS3BucketClient

Represents a scoped Amazon S3 client instance that is explicitly associated with a single S3 bucket. This wrapper provides a strongly-typed link between the client and the bucket it operates on, and optionally manages the lifetime of the underlying AmazonS3Client.

Inheritance

object

AmazonS3BucketClient

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Web

Assembly: SixLabors.ImageSharp.Web.Providers.AWS.dll

Syntax

public sealed class AmazonS3BucketClient : IDisposable

Constructors

AmazonS3BucketClient(string, AmazonS3Client, bool)

Initializes a new instance of the AmazonS3BucketClient class.

Declaration

public AmazonS3BucketClient(string bucketName, AmazonS3Client client, bool disposeClient = true)

Parameters

Type	Name	Description
string	bucketName	The bucket name associated with this client instance.
AmazonS3Client	client	The underlying Amazon S3 client instance. This should be an already configured instance of AmazonS3Client.
bool	disposeClient	A value indicating whether the underlying client should be disposed when this instance is disposed.

Properties

BucketName

Gets the bucket name associated with this client instance.

Declaration

public string BucketName { get; }

Property Value

Type	Description
string

Client

Gets the underlying Amazon S3 client instance.

Declaration

public AmazonS3Client Client { get; }

Property Value

Type	Description
AmazonS3Client

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Implements

IDisposable