@karmaniverous/aws-api-gateway-tools
    Preparing search index...

    Type Alias AwsApiGatewayToolsOptions

    Options for AwsApiGatewayTools construction.

    type AwsApiGatewayToolsOptions = {
        clientConfig?: APIGatewayClientConfig;
        xray?: XrayMode;
    }
    Index

    Properties

    clientConfig? xray?

    Properties

    clientConfig?: APIGatewayClientConfig

    AWS SDK v3 API Gateway client config.

    Include advanced settings here (region, credentials, retry config, custom endpoint, etc.). If a logger is provided, it must implement debug/info/warn/error.

    xray?: XrayMode

    AWS X-Ray capture mode.

    • auto (default): enable only when AWS_XRAY_DAEMON_ADDRESS is set.
    • on: force enable (throws if daemon address is missing).
    • off: disable.

    Settings

    Member Visibility

    On This Page

    Properties