Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/config-resolver

@aws-sdk/config-resolver

NPM version NPM downloads

An internal package

Usage

You probably shouldn't, at least directly.

Index

References

Interfaces

Type aliases

Variables

Functions

Object literals

References

CONFIG_USE_DUALSTACK_ENDPOINT

Re-exports CONFIG_USE_DUALSTACK_ENDPOINT

CONFIG_USE_DUALSTACK_ENDPOINT

Re-exports CONFIG_USE_DUALSTACK_ENDPOINT

CONFIG_USE_FIPS_ENDPOINT

Re-exports CONFIG_USE_FIPS_ENDPOINT

CONFIG_USE_FIPS_ENDPOINT

Re-exports CONFIG_USE_FIPS_ENDPOINT

CustomEndpointsInputConfig

Re-exports CustomEndpointsInputConfig

CustomEndpointsInputConfig

Re-exports CustomEndpointsInputConfig

CustomEndpointsResolvedConfig

Re-exports CustomEndpointsResolvedConfig

CustomEndpointsResolvedConfig

Re-exports CustomEndpointsResolvedConfig

DEFAULT_USE_DUALSTACK_ENDPOINT

Re-exports DEFAULT_USE_DUALSTACK_ENDPOINT

DEFAULT_USE_DUALSTACK_ENDPOINT

Re-exports DEFAULT_USE_DUALSTACK_ENDPOINT

DEFAULT_USE_FIPS_ENDPOINT

Re-exports DEFAULT_USE_FIPS_ENDPOINT

DEFAULT_USE_FIPS_ENDPOINT

Re-exports DEFAULT_USE_FIPS_ENDPOINT

ENV_USE_DUALSTACK_ENDPOINT

Re-exports ENV_USE_DUALSTACK_ENDPOINT

ENV_USE_DUALSTACK_ENDPOINT

Re-exports ENV_USE_DUALSTACK_ENDPOINT

ENV_USE_FIPS_ENDPOINT

Re-exports ENV_USE_FIPS_ENDPOINT

ENV_USE_FIPS_ENDPOINT

Re-exports ENV_USE_FIPS_ENDPOINT

EndpointsInputConfig

Re-exports EndpointsInputConfig

EndpointsInputConfig

Re-exports EndpointsInputConfig

EndpointsResolvedConfig

Re-exports EndpointsResolvedConfig

EndpointsResolvedConfig

Re-exports EndpointsResolvedConfig

GetRegionInfoOptions

Re-exports GetRegionInfoOptions

GetRegionInfoOptions

Re-exports GetRegionInfoOptions

NODE_REGION_CONFIG_FILE_OPTIONS

Re-exports NODE_REGION_CONFIG_FILE_OPTIONS

NODE_REGION_CONFIG_FILE_OPTIONS

Re-exports NODE_REGION_CONFIG_FILE_OPTIONS

NODE_REGION_CONFIG_OPTIONS

Re-exports NODE_REGION_CONFIG_OPTIONS

NODE_REGION_CONFIG_OPTIONS

Re-exports NODE_REGION_CONFIG_OPTIONS

NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

Re-exports NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

Re-exports NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

Re-exports NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

Re-exports NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

PartitionHash

Re-exports PartitionHash

PartitionHash

Re-exports PartitionHash

REGION_ENV_NAME

Re-exports REGION_ENV_NAME

REGION_ENV_NAME

Re-exports REGION_ENV_NAME

REGION_INI_NAME

Re-exports REGION_INI_NAME

REGION_INI_NAME

Re-exports REGION_INI_NAME

RegionHash

Re-exports RegionHash

RegionHash

Re-exports RegionHash

RegionInputConfig

Re-exports RegionInputConfig

RegionInputConfig

Re-exports RegionInputConfig

RegionResolvedConfig

Re-exports RegionResolvedConfig

RegionResolvedConfig

Re-exports RegionResolvedConfig

getRegionInfo

Re-exports getRegionInfo

getRegionInfo

Re-exports getRegionInfo

resolveCustomEndpointsConfig

Re-exports resolveCustomEndpointsConfig

resolveCustomEndpointsConfig

Re-exports resolveCustomEndpointsConfig

resolveEndpointsConfig

Re-exports resolveEndpointsConfig

resolveEndpointsConfig

Re-exports resolveEndpointsConfig

resolveRegionConfig

Re-exports resolveRegionConfig

resolveRegionConfig

Re-exports resolveRegionConfig

Type aliases

EndpointVariant

EndpointVariant: { hostname: string; tags: EndpointVariantTag[] }

Provides hostname information for specific host label.

Type declaration

EndpointVariantTag

EndpointVariantTag: "fips" | "dualstack"

The tag which mentions which area variant is providing information for. Can be either "fips" or "dualstack".

PartitionHash

PartitionHash: Record<string, { endpoint?: string; regionRegex: string; regions: string[]; variants: EndpointVariant[] }>

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.

RegionHash

RegionHash: Record<string, { signingRegion?: string; signingService?: string; variants: EndpointVariant[] }>

The hash of region with the information specific to that region. The information can include hostname, signingService and signingRegion.

Variables

Const CONFIG_USE_DUALSTACK_ENDPOINT

CONFIG_USE_DUALSTACK_ENDPOINT: "use_dualstack_endpoint" = "use_dualstack_endpoint"

Const CONFIG_USE_FIPS_ENDPOINT

CONFIG_USE_FIPS_ENDPOINT: "use_fips_endpoint" = "use_fips_endpoint"

Const DEFAULT_USE_DUALSTACK_ENDPOINT

DEFAULT_USE_DUALSTACK_ENDPOINT: false = false

Const DEFAULT_USE_FIPS_ENDPOINT

DEFAULT_USE_FIPS_ENDPOINT: false = false

Const ENV_USE_DUALSTACK_ENDPOINT

ENV_USE_DUALSTACK_ENDPOINT: "AWS_USE_DUALSTACK_ENDPOINT" = "AWS_USE_DUALSTACK_ENDPOINT"

Const ENV_USE_FIPS_ENDPOINT

ENV_USE_FIPS_ENDPOINT: "AWS_USE_FIPS_ENDPOINT" = "AWS_USE_FIPS_ENDPOINT"

Const REGION_ENV_NAME

REGION_ENV_NAME: "AWS_REGION" = "AWS_REGION"

Const REGION_INI_NAME

REGION_INI_NAME: "region" = "region"

Functions

Const getEndpointFromRegion

Const getHostnameFromVariants

  • getHostnameFromVariants(variants?: EndpointVariant[], __namedParameters: { useDualstackEndpoint: boolean; useFipsEndpoint: boolean }): string

Const getRealRegion

  • getRealRegion(region: string): string

Const getRegionInfo

  • getRegionInfo(region: string, __namedParameters: { partitionHash: PartitionHash; regionHash: RegionHash; signingService: string; useDualstackEndpoint: boolean; useFipsEndpoint: boolean }): RegionInfo

Const getResolvedHostname

  • getResolvedHostname(resolvedRegion: string, __namedParameters: { partitionHostname: string; regionHostname: string }): string | undefined

Const getResolvedPartition

  • getResolvedPartition(region: string, __namedParameters: { partitionHash: PartitionHash }): string

Const getResolvedSigningRegion

  • getResolvedSigningRegion(hostname: string, __namedParameters: { regionRegex: string; signingRegion: string; useFipsEndpoint: boolean }): string

Const isFipsRegion

  • isFipsRegion(region: string): boolean

Const resolveCustomEndpointsConfig

Const resolveEndpointsConfig

Const resolveRegionConfig

Object literals

Const NODE_REGION_CONFIG_FILE_OPTIONS

NODE_REGION_CONFIG_FILE_OPTIONS: object

preferredFile

preferredFile: "credentials" = "credentials"

Const NODE_REGION_CONFIG_OPTIONS

NODE_REGION_CONFIG_OPTIONS: object

configFileSelector

  • configFileSelector(profile: Profile): string

default

  • default(): never

environmentVariableSelector

  • environmentVariableSelector(env: ProcessEnv): string

Const NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS: object

default

default: false = false

configFileSelector

  • configFileSelector(profile: Profile): boolean

environmentVariableSelector

  • environmentVariableSelector(env: ProcessEnv): boolean

Const NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS: object

default

default: false = false

configFileSelector

  • configFileSelector(profile: Profile): boolean

environmentVariableSelector

  • environmentVariableSelector(env: ProcessEnv): boolean