Class S2Basins

Account-scoped helper for listing, creating, deleting, and reconfiguring basins.

Retrieve this via S2.basins. Each method retries according to the client-level retry config.

Index

Constructors

Methods

create delete getConfig list listAll reconfigure

Constructors

constructor

new S2Basins(client: Client, retryConfig: RetryConfig): S2Basins
Parameters
- client: Client
- retryConfig: RetryConfig
Returns S2Basins
- Defined in packages/streamstore/src/basins.ts:95

Methods

create

create(
args: CreateBasinInput,
options?: S2RequestOptions,
): Promise<CreateBasinResponse>
Create a basin.
Parameters
- args: CreateBasinInput
  Input for creating a basin.
  - basin: string
    Basin name which must be globally unique. It can be between 8 and 48 characters in length, and comprise lowercase letters, numbers and hyphens. It cannot begin or end with a hyphen.
  - Optionalconfig?: BasinConfig
    Basin configuration.
  - Optionalscope?: "aws:us-east-1"
    Basin scope.
- Optionaloptions: S2RequestOptions
Returns Promise<CreateBasinResponse>
- Defined in packages/streamstore/src/basins.ts:162

delete

delete(args: DeleteBasinInput, options?: S2RequestOptions): Promise<void>
Delete a basin.
Parameters
- args: DeleteBasinInput
  Input for deleting a basin.
  - basin: string
    Basin name.
- Optionaloptions: S2RequestOptions
Returns Promise<void>
- Defined in packages/streamstore/src/basins.ts:212

getConfig

getConfig(
args: GetBasinConfigInput,
options?: S2RequestOptions,
): Promise<BasinConfig>
Get basin configuration.
Parameters
- args: GetBasinConfigInput
  Input for getting basin configuration.
  - basin: string
    Basin name.
- Optionaloptions: S2RequestOptions
Returns Promise<BasinConfig>
- Defined in packages/streamstore/src/basins.ts:190

list

list(
args?: ListBasinsInput,
options?: S2RequestOptions,
): Promise<ListBasinsResponse>
List basins.
Parameters
- Optionalargs: ListBasinsInput
  Input for listing basins.
  - Optionallimit?: number
    Number of results, up to a maximum of 1000.
  - Optionalprefix?: string
    Filter to basins whose names begin with this prefix.
  - OptionalstartAfter?: string
    Filter to basins whose names lexicographically start after this string.
- Optionaloptions: S2RequestOptions
Returns Promise<ListBasinsResponse>
- Defined in packages/streamstore/src/basins.ts:107

listAll

listAll(
    includeDeleted?: boolean,
    args?: ListAllBasinsInput,
    options?: S2RequestOptions,
): AsyncIterable<BasinInfo>
List all basins with automatic pagination. Returns a lazy async iterable that fetches pages as needed.
Parameters
- includeDeleted: boolean = false
  Include basins that are being deleted (default: false)
- Optionalargs: ListAllBasinsInput
  Optional filtering options: prefix to filter by name prefix, limit for max results per page
- Optionaloptions: S2RequestOptions
Returns AsyncIterable<BasinInfo>
Example
```
for await (const basin of s2.basins.listAll(false, { prefix: "my-" })) {
  console.log(basin.name);
}
```
- Defined in packages/streamstore/src/basins.ts:137

reconfigure

reconfigure(
args: ReconfigureBasinInput,
options?: S2RequestOptions,
): Promise<BasinConfig>
Reconfigure a basin.
Parameters
- args: ReconfigureBasinInput
  Configuration for the basin to reconfigure (including basin name and fields to change)
- Optionaloptions: S2RequestOptions
Returns Promise<BasinConfig>
- Defined in packages/streamstore/src/basins.ts:232