UNPKG

1.33 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 a custom endpoint (for example, when using a local version of S3).
5 */
6 endpoint?: string | Endpoint | Provider<Endpoint>;
7 /**
8 * Whether TLS is enabled for requests.
9 */
10 tls?: boolean;
11 /**
12 * Enables IPv6/IPv4 dualstack endpoint.
13 */
14 useDualstackEndpoint?: boolean | Provider<boolean>;
15}
16interface PreviouslyResolved {
17 regionInfoProvider: RegionInfoProvider;
18 urlParser: UrlParser;
19 region: Provider<string>;
20 useFipsEndpoint: Provider<boolean>;
21}
22export interface EndpointsResolvedConfig extends Required<EndpointsInputConfig> {
23 /**
24 * Resolved value for input {@link EndpointsInputConfig.endpoint}
25 */
26 endpoint: Provider<Endpoint>;
27 /**
28 * Whether the endpoint is specified by caller.
29 * @internal
30 */
31 isCustomEndpoint: boolean;
32 /**
33 * Resolved value for input {@link EndpointsInputConfig.useDualstackEndpoint}
34 */
35 useDualstackEndpoint: Provider<boolean>;
36}
37export declare const resolveEndpointsConfig: <T>(input: T & EndpointsInputConfig & PreviouslyResolved) => T & EndpointsResolvedConfig;
38export {};