Interface DynamodbPluginConfig

DynamoDB plugin config slice.

Remarks

This is the public, documented config shape for the DynamoDB get-dotenv plugin. The schema value is intentionally not part of the exported docs surface; consumers should configure via this type.

interface DynamodbPluginConfig {
    create?: {
        force?: boolean;
        refreshGenerated?: boolean;
        tableNameOverride?: string;
        validate?: boolean;
        version?: string;
        waiter?: { maxSeconds?: string | number };
    };
    delete?: { tableName?: string; waiter?: { maxSeconds?: string
    | number } };
    generate?: {
        clean?: boolean;
        tableProperties?: {
            billingMode?: string;
            readCapacityUnits?: string | number;
            tableName?: string;
            writeCapacityUnits?: string | number;
        };
        version?: string;
    };
    local?: {
        endpoint?: string;
        port?: string
        | number;
        start?: string;
        status?: string;
        stop?: string;
    };
    migrate?: {
        fromVersion?: string;
        limit?: string
        | number;
        pageSize?: string | number;
        progressIntervalMs?: string | number;
        sourceTable?: string;
        targetTable?: string;
        toVersion?: string;
        transformConcurrency?: string | number;
    };
    minTableVersionWidth?: string
    | number;
    purge?: { tableName?: string };
    tablesPath?: string;
    tokens?: { entityManager?: string; table?: string; transform?: string };
    validate?: { version?: string };
}

Index

Properties

create? delete? generate? local? migrate? minTableVersionWidth? purge? tablesPath? tokens? validate?

Properties

`Optional`create

create?: {
    force?: boolean;
    refreshGenerated?: boolean;
    tableNameOverride?: string;
    validate?: boolean;
    version?: string;
    waiter?: { maxSeconds?: string | number };
}

Defaults for create.

Type Declaration

Optionalforce?: boolean
Proceed on drift when validation fails.
OptionalrefreshGenerated?: boolean
Refresh generated sections in place before create.
OptionaltableNameOverride?: string
One-off TableName override (does not persist to YAML).
Optionalvalidate?: boolean
Validate drift before create.
Optionalversion?: string
Default version token (NNN).
Optionalwaiter?: { maxSeconds?: string | number }
Waiter configuration for table create.
- OptionalmaxSeconds?: string | number
  Max waiter duration in seconds.

`Optional`delete

delete?: { tableName?: string; waiter?: { maxSeconds?: string | number } }

Defaults for delete.

Type Declaration

OptionaltableName?: string
Default table name (dotenv-expanded by the host).
Optionalwaiter?: { maxSeconds?: string | number }
Waiter configuration for table delete.
- OptionalmaxSeconds?: string | number
  Max waiter duration in seconds.

`Optional`generate

generate?: {
    clean?: boolean;
    tableProperties?: {
        billingMode?: string;
        readCapacityUnits?: string | number;
        tableName?: string;
        writeCapacityUnits?: string | number;
    };
    version?: string;
}

Defaults for generate (compose/refresh table.yml).

Type Declaration

Optionalclean?: boolean
When true, regenerate from baseline template + generated + managed properties.
OptionaltableProperties?: {
    billingMode?: string;
    readCapacityUnits?: string | number;
    tableName?: string;
    writeCapacityUnits?: string | number;
}
Managed (tooling-controlled) table Properties (non-generated keys).
- OptionalbillingMode?: string
  Billing mode (e.g., "PAY_PER_REQUEST" or "PROVISIONED").
- OptionalreadCapacityUnits?: string | number
  Provisioned RCU (requires billingMode="PROVISIONED").
- OptionaltableName?: string
  Managed Properties.TableName.
- OptionalwriteCapacityUnits?: string | number
  Provisioned WCU (requires billingMode="PROVISIONED").
Optionalversion?: string
Default version token (NNN).

`Optional`local

local?: {
    endpoint?: string;
    port?: string | number;
    start?: string;
    status?: string;
    stop?: string;
}

Local DynamoDB orchestration config (config-first; embedded fallback).

Type Declaration

Optionalendpoint?: string
Endpoint override (e.g., "http://localhost:8000").
Optionalport?: string | number
Local port (used for endpoint derivation).
Optionalstart?: string
Shell command to start local DynamoDB.
Optionalstatus?: string
Shell command to check local DynamoDB status (exit 0 = healthy).
Optionalstop?: string
Shell command to stop local DynamoDB.

`Optional`migrate

migrate?: {
    fromVersion?: string;
    limit?: string | number;
    pageSize?: string | number;
    progressIntervalMs?: string | number;
    sourceTable?: string;
    targetTable?: string;
    toVersion?: string;
    transformConcurrency?: string | number;
}

Defaults for migrate.

Type Declaration

OptionalfromVersion?: string
From version token (NNN; exclusive).
Optionallimit?: string | number
Max outputs to write.
OptionalpageSize?: string | number
DynamoDB scan page size.
OptionalprogressIntervalMs?: string | number
Progress tick interval in ms.
OptionalsourceTable?: string
Source table name (dotenv-expanded by the host).
OptionaltargetTable?: string
Target table name (dotenv-expanded by the host).
OptionaltoVersion?: string
To version token (NNN; inclusive).
OptionaltransformConcurrency?: string | number
Transform concurrency within a page.

`Optional`minTableVersionWidth

minTableVersionWidth?: string | number

Minimum width for left-zero padding when formatting version tokens (default: 3).

`Optional`purge

purge?: { tableName?: string }

Defaults for purge.

Type Declaration

OptionaltableName?: string
Default table name (dotenv-expanded by the host).

`Optional`tablesPath

tablesPath?: string

Root path for versioned assets (default: "tables").

`Optional`tokens

tokens?: { entityManager?: string; table?: string; transform?: string }

Filename tokens (without extensions) for the versioned layout.

Type Declaration

OptionalentityManager?: string
EntityManager module token (default: "entityManager").
Optionaltable?: string
Table definition token (default: "table").
Optionaltransform?: string
Transform module token (default: "transform").

`Optional`validate

validate?: { version?: string }

Defaults for validate.

Type Declaration

Optionalversion?: string
Default version token (NNN).

Interface DynamodbPluginConfig

Remarks

Index

Properties

Properties

Optionalcreate

Type Declaration

Optionalforce?: boolean

OptionalrefreshGenerated?: boolean

OptionaltableNameOverride?: string

Optionalvalidate?: boolean

Optionalversion?: string

Optionalwaiter?: { maxSeconds?: string | number }

OptionalmaxSeconds?: string | number

Optionaldelete

Type Declaration

OptionaltableName?: string

Optionalwaiter?: { maxSeconds?: string | number }

OptionalmaxSeconds?: string | number

Optionalgenerate

Type Declaration

Optionalclean?: boolean

OptionaltableProperties?: { billingMode?: string; readCapacityUnits?: string | number; tableName?: string; writeCapacityUnits?: string | number;}

OptionalbillingMode?: string

OptionalreadCapacityUnits?: string | number

OptionaltableName?: string

OptionalwriteCapacityUnits?: string | number

Optionalversion?: string

Optionallocal

Type Declaration

Optionalendpoint?: string

Optionalport?: string | number

Optionalstart?: string

Optionalstatus?: string

Optionalstop?: string

Optionalmigrate

Type Declaration

OptionalfromVersion?: string

Optionallimit?: string | number

OptionalpageSize?: string | number

OptionalprogressIntervalMs?: string | number

OptionalsourceTable?: string

OptionaltargetTable?: string

OptionaltoVersion?: string

OptionaltransformConcurrency?: string | number

OptionalminTableVersionWidth

Optionalpurge

Type Declaration

OptionaltableName?: string

OptionaltablesPath

Optionaltokens

Type Declaration

OptionalentityManager?: string

Optionaltable?: string

Optionaltransform?: string

Optionalvalidate

Type Declaration

Optionalversion?: string

Settings

On This Page

`Optional`create

`Optional`force?: boolean

`Optional`refreshGenerated?: boolean

`Optional`tableNameOverride?: string

`Optional`validate?: boolean

`Optional`version?: string

`Optional`waiter?: { maxSeconds?: string | number }

`Optional`maxSeconds?: string | number

`Optional`delete

`Optional`tableName?: string

`Optional`waiter?: { maxSeconds?: string | number }

`Optional`maxSeconds?: string | number

`Optional`generate

`Optional`clean?: boolean

`Optional`tableProperties?: {
billingMode?: string;
readCapacityUnits?: string | number;
tableName?: string;
writeCapacityUnits?: string | number;
}

`Optional`billingMode?: string

`Optional`readCapacityUnits?: string | number

`Optional`tableName?: string

`Optional`writeCapacityUnits?: string | number

`Optional`version?: string

`Optional`local

`Optional`endpoint?: string

`Optional`port?: string | number

`Optional`start?: string

`Optional`status?: string

`Optional`stop?: string

`Optional`migrate

`Optional`fromVersion?: string

`Optional`limit?: string | number

`Optional`pageSize?: string | number

`Optional`progressIntervalMs?: string | number

`Optional`sourceTable?: string

`Optional`targetTable?: string

`Optional`toVersion?: string

`Optional`transformConcurrency?: string | number

`Optional`minTableVersionWidth

`Optional`purge

`Optional`tableName?: string

`Optional`tablesPath

`Optional`tokens

`Optional`entityManager?: string

`Optional`table?: string

`Optional`transform?: string

`Optional`validate

`Optional`version?: string