ts-lambda-api - v2.5.2
    Preparing search index...

    Interface EndpointInputConfig<T>

    Endpoint config interfaces and resolver for Endpoint v2. They live in separate package to allow per-service onboarding. When all services onboard Endpoint v2, the resolver in config-resolver package can be removed. This interface includes all the endpoint parameters with built-in bindings of "AWS::" and "SDK::"

    interface EndpointInputConfig<T extends EndpointParameters = EndpointParameters> {
        endpoint?:
            | string
            | EndpointV2
            | Endpoint
            | Provider<Endpoint>
            | Provider<EndpointV2>;
        endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2;
        serviceConfiguredEndpoint?: never;
        tls?: boolean;
        useDualstackEndpoint?: boolean | Provider<boolean>;
        useFipsEndpoint?: boolean | Provider<boolean>;
    }

    Type Parameters

    Index

    Properties

    endpoint? endpointProvider? serviceConfiguredEndpoint? tls? useDualstackEndpoint? useFipsEndpoint?

    Properties

    endpoint?:
        | string
        | EndpointV2
        | Endpoint
        | Provider<Endpoint>
        | Provider<EndpointV2>

    The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).

    Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

    endpointProvider?: (params: T, context?: { logger?: Logger }) => EndpointV2

    Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

    serviceConfiguredEndpoint?: never

    This field is used internally so you should not fill any value to this field.

    tls?: boolean

    Whether TLS is enabled for requests.

    useDualstackEndpoint?: boolean | Provider<boolean>

    Enables IPv6/IPv4 dualstack endpoint.

    useFipsEndpoint?: boolean | Provider<boolean>

    Enables FIPS compatible endpoints.

    Settings

    Member Visibility

    On This Page

    Properties