@resistdesign/voltra
    Preparing search index...

    Type Alias DynamoDBSpecificConfig

    DynamoDB client configuration subset for generated docs.

    type DynamoDBSpecificConfig = {
        apiVersion?: string;
        base64Decoder?: string;
        base64Encoder?: string;
        bodyLengthChecker?: string;
        credentialDefaultProvider?: string;
        credentials?: string;
        customUserAgent?: string;
        defaultsMode?:
            | "standard"
            | "in-region"
            | "cross-region"
            | "mobile"
            | "auto"
            | "legacy";
        defaultUserAgentProvider?: string;
        disableHostPrefix?: string
        | false
        | true;
        endpoint?: string | Endpoint;
        endpointCacheSize?: string;
        endpointDiscoveryEnabled?: string | false | true;
        endpointDiscoveryEnabledProvider?: string;
        endpointProvider?: string;
        extensions?: string;
        httpAuthSchemeProvider?: string;
        httpAuthSchemes?: string;
        logger?: string | Logger;
        maxAttempts?: string;
        region?: string;
        requestHandler?: string;
        retryMode?: string;
        retryStrategy?: string | RetryStrategy;
        runtime?: string;
        serviceId?: string;
        sha256?: string;
        signer?: string;
        signerConstructor?: string;
        signingEscapePath?: string | false | true;
        signingRegion?: string;
        streamCollector?: string;
        systemClockOffset?: string;
        tls?: string | false | true;
        urlParser?: string;
        useDualstackEndpoint?: string | false | true;
        useFipsEndpoint?: string | false | true;
        useFirstSortFieldAsIndexName?: boolean;
        utf8Decoder?: string;
        utf8Encoder?: string;
    }
    Index

    Properties

    apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? credentialDefaultProvider? credentials? customUserAgent? defaultsMode? defaultUserAgentProvider? disableHostPrefix? endpoint? endpointCacheSize? endpointDiscoveryEnabled? endpointDiscoveryEnabledProvider? endpointProvider? extensions? httpAuthSchemeProvider? httpAuthSchemes? logger? maxAttempts? region? requestHandler? retryMode? retryStrategy? runtime? serviceId? sha256? signer? signerConstructor? signingEscapePath? signingRegion? streamCollector? systemClockOffset? tls? urlParser? useDualstackEndpoint? useFipsEndpoint? useFirstSortFieldAsIndexName? utf8Decoder? utf8Encoder?

    Properties

    apiVersion?: string

    API version override for the DynamoDB client.

    base64Decoder?: string

    Base64 decoder override.

    base64Encoder?: string

    Base64 encoder override.

    bodyLengthChecker?: string

    Body length checker override.

    credentialDefaultProvider?: string

    Credential provider override.

    credentials?: string

    Credentials override.

    customUserAgent?: string

    Custom user agent string.

    defaultsMode?:
        | "standard"
        | "in-region"
        | "cross-region"
        | "mobile"
        | "auto"
        | "legacy"

    Defaults mode selector for AWS SDK config.

    defaultUserAgentProvider?: string

    Default user agent provider override.

    disableHostPrefix?: string | false | true

    Disable host prefix injection.

    endpoint?: string | Endpoint

    Explicit endpoint override.

    endpointCacheSize?: string

    Endpoint cache size override.

    endpointDiscoveryEnabled?: string | false | true

    Enable endpoint discovery.

    endpointDiscoveryEnabledProvider?: string

    Endpoint discovery provider override.

    endpointProvider?: string

    Endpoint provider override.

    extensions?: string

    Extensions applied to the client.

    httpAuthSchemeProvider?: string

    HTTP auth scheme provider override.

    httpAuthSchemes?: string

    HTTP auth schemes override.

    logger?: string | Logger

    Logger configuration or identifier.

    maxAttempts?: string

    Maximum retry attempts.

    region?: string

    AWS region identifier.

    requestHandler?: string

    Custom request handler override.

    retryMode?: string

    Retry mode identifier.

    retryStrategy?: string | RetryStrategy

    Retry strategy override.

    runtime?: string

    Runtime identifier override.

    serviceId?: string

    Service id override.

    sha256?: string

    Hash implementation identifier.

    signer?: string

    Signer override.

    signerConstructor?: string

    Signer constructor override.

    signingEscapePath?: string | false | true

    Signing path escape toggle.

    signingRegion?: string

    Signing region override.

    streamCollector?: string

    Stream collector override.

    systemClockOffset?: string

    System clock offset override.

    tls?: string | false | true

    TLS usage override.

    urlParser?: string

    URL parser override.

    useDualstackEndpoint?: string | false | true

    Enable dualstack endpoints.

    useFipsEndpoint?: string | false | true

    Enable FIPS endpoints.

    useFirstSortFieldAsIndexName?: boolean

    When true, the first sort field is treated as the DynamoDB index name.

    utf8Decoder?: string

    UTF-8 decoder override.

    utf8Encoder?: string

    UTF-8 encoder override.

    Settings

    Member Visibility

    On This Page

    Properties