Setu-TS
    Preparing search index...

    Interface DynamoDatabaseOptions

    The arm selecting the DynamoDB adapter over the AWS SDK v3 client.

    options.region is required by the union unless options.client is supplied, so a registration that forgets both is a compile error instead of a connect() throw — the same guarantee the 'custom' arm gives adapter. The client is supplied inject-or-lazy (§12.2 of AI_GUIDELINES): client is an already-constructed structural IDynamoClient, and absent it the adapter performs a literal import('@aws-sdk/client-dynamodb') at connect time.

    import { DatabasePlugin } from '@setu-ts/database-plugin';

    DatabasePlugin({
      type: 'dynamodb',
      options: { region: 'us-east-1' },
    });

    0.2.0

    interface DynamoDatabaseOptions {
        name?: string;
        options: DynamoAdapterOptions;
        readiness?: DatabaseReadinessOptions;
        type: "dynamodb";
    }

    Hierarchy (View Summary)

    Index
    name? options readiness? type
    name?: string

    Named connection for multi-database support. Defaults to 'default'.

    When a name is provided, the service registers under database.<name> (e.g. database.primary); otherwise it uses the canonical CAPABILITIES.DATABASE token. Dot notation, not a colon: createCapabilityToken rejects colons.

    0.1.0

    options: DynamoAdapterOptions

    DynamoDB adapter configuration; region (or client) is required.

    readiness?: DatabaseReadinessOptions

    Optional schema readiness, evaluated by this connection's health indicator.

    0.10.0

    type: "dynamodb"

    Selects the DynamoDB arm.

    Settings
    Member Visibility

    On This Page
    Properties