Table of Contents

Interface IEventSourcingAwsS3Builder

Namespace
Excalibur.EventSourcing.AwsS3
Assembly
Excalibur.EventSourcing.AwsS3.dll

Fluent builder for configuring AWS S3 cold event store settings.

public interface IEventSourcingAwsS3Builder

Remarks

Connection methods (ServiceUrl(string), Region(string), Client(IAmazonS3), ClientFactory(Func<IServiceProvider, IAmazonS3>), BindConfiguration(string)) use last-wins semantics: setting one clears the others.

Non-connection methods (BucketName(string), KeyPrefix(string)) are additive and can be combined with any connection method.

Methods

BindConfiguration(string)

Binds options from an IConfiguration section.

IEventSourcingAwsS3Builder BindConfiguration(string sectionPath)

Parameters

sectionPath string

Returns

IEventSourcingAwsS3Builder

BucketName(string)

Sets the S3 bucket name for cold event storage.

IEventSourcingAwsS3Builder BucketName(string bucketName)

Parameters

bucketName string

Returns

IEventSourcingAwsS3Builder

Client(IAmazonS3)

Sets a pre-configured Amazon.S3.IAmazonS3 client.

IEventSourcingAwsS3Builder Client(IAmazonS3 client)

Parameters

client IAmazonS3

Returns

IEventSourcingAwsS3Builder

ClientFactory(Func<IServiceProvider, IAmazonS3>)

Sets a factory that resolves an Amazon.S3.IAmazonS3 from DI.

IEventSourcingAwsS3Builder ClientFactory(Func<IServiceProvider, IAmazonS3> clientFactory)

Parameters

clientFactory Func<IServiceProvider, IAmazonS3>

Returns

IEventSourcingAwsS3Builder

KeyPrefix(string)

Sets the key prefix for archived event objects.

IEventSourcingAwsS3Builder KeyPrefix(string keyPrefix)

Parameters

keyPrefix string

Returns

IEventSourcingAwsS3Builder

Layout(ColdArchiveLayout)

Selects the archive layout captured at provider construction. Defaults to Legacy.

IEventSourcingAwsS3Builder Layout(ColdArchiveLayout layout)

Parameters

layout ColdArchiveLayout

Returns

IEventSourcingAwsS3Builder

Remarks

TypedV2 requires explicit activation and migration of a fixed single-bucket namespace.

Region(string)

Sets the AWS region explicitly (as a string, e.g. "us-east-1").

IEventSourcingAwsS3Builder Region(string region)

Parameters

region string

Returns

IEventSourcingAwsS3Builder

ServiceUrl(string)

Sets the S3 service URL (for LocalStack or custom endpoints).

IEventSourcingAwsS3Builder ServiceUrl(string serviceUrl)

Parameters

serviceUrl string

Returns

IEventSourcingAwsS3Builder