Basin Resources

Basins are containers for streams, similar to buckets in object storage. Each basin belongs to an account and has its own configuration for default stream settings, which will be used when creating new streams unless explicitly overridden.

TypeScript
Go
Rust

// List basins
const basins = await client.basins.list();

// Create a basin
await client.basins.create({ basin: "my-events" });

// Get configuration
const config = await client.basins.getConfig({ basin: "my-events" });

// Delete
await client.basins.delete({ basin: "my-events" });

// List basins
basins, _ := client.Basins.List(ctx, nil)

// Create a basin
client.Basins.Create(ctx, s2.CreateBasinArgs{Basin: "my-events"})

// Get configuration
config, _ := client.Basins.GetConfig(ctx, "my-events")

// Delete
client.Basins.Delete(ctx, "my-events")

// List basins
let basins = client.list_basins(ListBasinsInput::new()).await?;

// Create a basin
client
    .create_basin(CreateBasinInput::new("my-events".parse()?))
    .await?;

// Get configuration
let config = client.get_basin_config("my-events".parse()?).await?;

// Delete
client
    .delete_basin(DeleteBasinInput::new("my-events".parse()?))
    .await?;

See basin configuration for details on available options.

SDKs