prorm API Reference
    Preparing search index...

    Interface DynamoDbStoreOptions

    interface DynamoDbStoreOptions {
        region?: string;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        clientConfig?: DynamoDBClientConfig;
        translateConfig?: TranslateConfig;
    }
    Index
    region? credentials? endpoint? clientConfig? translateConfig?
    region?: string

    AWS region, e.g. 'us-east-1'. Required unless using a local endpoint that ignores it.

    credentials?: {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Static credentials. Omit to fall back to the default AWS credential provider chain.

    endpoint?: string

    Override the service endpoint, e.g. 'http://localhost:8000' for DynamoDB Local / dynamodb-local test containers. When set, region and credentials can be dummy values since DynamoDB Local doesn't validate them.

    clientConfig?: DynamoDBClientConfig

    Passed straight through to the underlying DynamoDBClient constructor for anything not covered above.

    translateConfig?: TranslateConfig

    Marshalling options for the document client (e.g. { removeUndefinedValues: true }).

    Settings
    Member Visibility

    On This Page
    Properties