Skip to main content
A container for streams, similar to a bucket in object storage. Each basin has a globally unique name and lives in a specific cell within a location. The basin name is reflected in the data plane endpoint: 
https://{basin}.b.s2.dev

​
Configuration

Basins carry configuration that governs stream auto-creation and defaults for streams in the basin. Enabling create_stream_on_(append|read) lets you skip explicit stream creation — just start operating and the stream will be created automatically with the basin’s default stream config. A basin can also set the encryption algorithm for newly created streams. Each stream captures that cipher when it is created.

​
Location

Every basin is characterized by a logical location, established on basin creation. This is fixed for the lifetime of the basin. The main impact of location is on latency with clients; generally, the closer you are to the location, the better latency you will experience. A basin location corresponds to a replication environment (e.g., a region within a cloud provider) in which S2 is deployed. The currently available locations are aws:us-east-1, aws:us-west-2, and aws:eu-north-1. A default location can be set at the account level. This location will be used for newly created basins that do not specify a location. A location can also represent a private, dedicated cell, if so desired. Contact us if you need this!

​
Naming

Streams within a basin are addressed as s2://{basin}/{stream}. Stream names can contain / (or any other delimiter) to create logical hierarchies: 
s2://my-basin/sessions/user-123/run-456
s2://my-basin/logs/prod/api-server
This is a naming convention only — there is no directory structure. Listing streams supports prefix filtering, and access tokens can be scoped to prefixes as well.

​
Limits

The number of basins per account is unlimited (for all customers with a payment method; otherwise limited to 100). Streams within a basin are unlimited. See limits for details.

​
See also

Basin SDK

Create, configure, list, and delete basins from SDK clients.

Basin API

Review the basin management endpoints.