@aws-sdk/config-resolver

  • Version 3.295.0
  • Published
  • 48.5 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-sdk/config-resolver
yarn add @aws-sdk/config-resolver
pnpm add @aws-sdk/config-resolver

Overview

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/config-resolver/latest.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sd

Index

Variables

variable CONFIG_USE_DUALSTACK_ENDPOINT

const CONFIG_USE_DUALSTACK_ENDPOINT: string;

    variable CONFIG_USE_FIPS_ENDPOINT

    const CONFIG_USE_FIPS_ENDPOINT: string;

      variable DEFAULT_USE_DUALSTACK_ENDPOINT

      const DEFAULT_USE_DUALSTACK_ENDPOINT: boolean;

        variable DEFAULT_USE_FIPS_ENDPOINT

        const DEFAULT_USE_FIPS_ENDPOINT: boolean;

          variable ENV_USE_DUALSTACK_ENDPOINT

          const ENV_USE_DUALSTACK_ENDPOINT: string;

            variable ENV_USE_FIPS_ENDPOINT

            const ENV_USE_FIPS_ENDPOINT: string;

              variable NODE_REGION_CONFIG_FILE_OPTIONS

              const NODE_REGION_CONFIG_FILE_OPTIONS: LocalConfigOptions;

                variable NODE_REGION_CONFIG_OPTIONS

                const NODE_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<string>;

                  variable NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

                  const NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean>;

                    variable NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

                    const NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean>;

                      variable REGION_ENV_NAME

                      const REGION_ENV_NAME: string;

                        variable REGION_INI_NAME

                        const REGION_INI_NAME: string;

                          Functions

                          function getRegionInfo

                          getRegionInfo: (
                          region: string,
                          {
                          useFipsEndpoint,
                          useDualstackEndpoint,
                          signingService,
                          regionHash,
                          partitionHash,
                          }: GetRegionInfoOptions
                          ) => RegionInfo;

                            function resolveCustomEndpointsConfig

                            resolveCustomEndpointsConfig: <T>(
                            input: T & CustomEndpointsInputConfig & PreviouslyResolved
                            ) => T & CustomEndpointsResolvedConfig;

                              function resolveEndpointsConfig

                              resolveEndpointsConfig: <T>(
                              input: T & EndpointsInputConfig & PreviouslyResolved
                              ) => T & EndpointsResolvedConfig;
                              • Deprecated

                                endpoints rulesets use @aws-sdk/middleware-endpoint resolveEndpointConfig. All generated clients should migrate to Endpoints 2.0 endpointRuleSet traits.

                              function resolveRegionConfig

                              resolveRegionConfig: <T>(
                              input: T & RegionInputConfig & PreviouslyResolved
                              ) => T & RegionResolvedConfig;

                                Interfaces

                                interface CustomEndpointsInputConfig

                                interface CustomEndpointsInputConfig extends EndpointsInputConfig {}

                                  property endpoint

                                  endpoint: string | Endpoint | Provider<Endpoint>;
                                  • The fully qualified endpoint of the webservice.

                                  interface CustomEndpointsResolvedConfig

                                  interface CustomEndpointsResolvedConfig extends EndpointsResolvedConfig {}

                                    interface EndpointsInputConfig

                                    interface EndpointsInputConfig {}

                                      property endpoint

                                      endpoint?: string | Endpoint | Provider<Endpoint>;
                                      • 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).

                                      property tls

                                      tls?: boolean;
                                      • Whether TLS is enabled for requests.

                                      property useDualstackEndpoint

                                      useDualstackEndpoint?: boolean | Provider<boolean>;
                                      • Enables IPv6/IPv4 dualstack endpoint.

                                      interface EndpointsResolvedConfig

                                      interface EndpointsResolvedConfig extends Required<EndpointsInputConfig> {}

                                        property endpoint

                                        endpoint: Provider<Endpoint>;

                                        property useDualstackEndpoint

                                        useDualstackEndpoint: Provider<boolean>;

                                        interface GetRegionInfoOptions

                                        interface GetRegionInfoOptions {}

                                          property partitionHash

                                          partitionHash: PartitionHash;

                                            property regionHash

                                            regionHash: RegionHash;

                                              property signingService

                                              signingService: string;

                                                property useDualstackEndpoint

                                                useDualstackEndpoint?: boolean;

                                                  property useFipsEndpoint

                                                  useFipsEndpoint?: boolean;

                                                    interface RegionInputConfig

                                                    interface RegionInputConfig {}

                                                      property region

                                                      region?: string | Provider<string>;
                                                      • The AWS region to which this client will send requests

                                                      property useFipsEndpoint

                                                      useFipsEndpoint?: boolean | Provider<boolean>;
                                                      • Enables FIPS compatible endpoints.

                                                      interface RegionResolvedConfig

                                                      interface RegionResolvedConfig {}

                                                        property region

                                                        region: Provider<string>;

                                                        property useFipsEndpoint

                                                        useFipsEndpoint: Provider<boolean>;

                                                        Type Aliases

                                                        type PartitionHash

                                                        type PartitionHash = Record<
                                                        string,
                                                        {
                                                        regions: string[];
                                                        regionRegex: string;
                                                        variants: EndpointVariant[];
                                                        endpoint?: string;
                                                        }
                                                        >;
                                                        • The hash of partition with the information specific to that partition. The information includes the list of regions belonging to that partition, and the hostname to be used for the partition.

                                                        type RegionHash

                                                        type RegionHash = Record<
                                                        string,
                                                        {
                                                        variants: EndpointVariant[];
                                                        signingService?: string;
                                                        signingRegion?: string;
                                                        }
                                                        >;
                                                        • The hash of region with the information specific to that region. The information can include hostname, signingService and signingRegion.

                                                        Package Files (10)

                                                        Dependencies (5)

                                                        Dev Dependencies (7)

                                                        Peer Dependencies (0)

                                                        No peer dependencies.

                                                        Badge

                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-sdk/config-resolver.

                                                        • Markdown
                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-sdk/config-resolver)
                                                        • HTML
                                                          <a href="https://www.jsdocs.io/package/@aws-sdk/config-resolver"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>