UNPKG

1.52 kBTypeScriptView Raw
1import { Endpoint, Provider, RegionInfoProvider, UrlParser } from "@aws-sdk/types";
2export interface EndpointsInputConfig {
3 /**
4 * The fully qualified endpoint of the webservice. This is only required when using
5 * a custom endpoint (for example, when using a local version of S3).
6 */
7 endpoint?: string | Endpoint | Provider<Endpoint>;
8 /**
9 * Whether TLS is enabled for requests.
10 */
11 tls?: boolean;
12 /**
13 * Enables IPv6/IPv4 dualstack endpoint.
14 */
15 useDualstackEndpoint?: boolean | Provider<boolean>;
16}
17interface PreviouslyResolved {
18 regionInfoProvider: RegionInfoProvider;
19 urlParser: UrlParser;
20 region: Provider<string>;
21 useFipsEndpoint: Provider<boolean>;
22}
23export interface EndpointsResolvedConfig extends Required<EndpointsInputConfig> {
24 /**
25 * Resolved value for input {@link EndpointsInputConfig.endpoint}
26 */
27 endpoint: Provider<Endpoint>;
28 /**
29 * Whether the endpoint is specified by caller.
30 * @internal
31 */
32 isCustomEndpoint?: boolean;
33 /**
34 * Resolved value for input {@link EndpointsInputConfig.useDualstackEndpoint}
35 */
36 useDualstackEndpoint: Provider<boolean>;
37}
38/**
39 * @deprecated endpoints rulesets use @aws-sdk/middleware-endpoint resolveEndpointConfig.
40 * All generated clients should migrate to Endpoints 2.0 endpointRuleSet traits.
41 */
42export declare const resolveEndpointsConfig: <T>(input: T & EndpointsInputConfig & PreviouslyResolved) => T & EndpointsResolvedConfig;
43export {};