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> {
    endpoint?: string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
    endpointProvider?: ((params, context?) => EndpointV2);
    tls?: boolean;
    useDualstackEndpoint?: boolean | Provider<boolean>;
    useFipsEndpoint?: boolean | Provider<boolean>;
}

Type Parameters

Properties

endpoint? endpointProvider? tls? useDualstackEndpoint? useFipsEndpoint?

Properties

Optional endpoint

endpoint?: string | Endpoint | Provider<Endpoint> | EndpointV2 | 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.

Optional endpointProvider

endpointProvider?: ((params, context?) => 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.

Type declaration

    • (params, context?): 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.

      Parameters

      • params: T
      • Optional context: {
            logger?: Logger;
        }

      Returns EndpointV2

Optional tls

tls?: boolean

Whether TLS is enabled for requests.

Deprecated

Optional useDualstackEndpoint

useDualstackEndpoint?: boolean | Provider<boolean>

Enables IPv6/IPv4 dualstack endpoint.

Optional useFipsEndpoint

useFipsEndpoint?: boolean | Provider<boolean>

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme

On This Page