Class S2Basin

constructor

• new S2Basin(
      name: string,
      options: {
          accessToken: Redacted;
          baseUrl: string;
          includeBasinHeader: boolean;
          retryConfig?: RetryConfig;
      },
  ): S2Basin

  Create a basin-scoped client that talks to https://{basin}.b.aws.s2.dev/v1.

  Use this to work with streams inside a single basin.

  Parameters

  • name: string

    Basin name

  • options: {
        accessToken: Redacted;
        baseUrl: string;
        includeBasinHeader: boolean;
        retryConfig?: RetryConfig;
    }

    Configuration for the basin-scoped client

  Returns S2Basin

Readonlyname

Readonlystreams

stream

• stream(name: string, options?: StreamOptions): S2Stream

  Create a stream-scoped helper bound to this basin.

  Parameters

  • name: string

    Stream name

  • Optionaloptions: StreamOptions

  Returns S2Stream