@aws-sdk/util-defaults-mode-node

An internal package

Usage

You probably shouldn't, at least directly.

Index

References

Interfaces

ResolveDefaultsModeConfigOptions

Variables

Functions

Object literals

NODE_DEFAULTS_MODE_CONFIG_OPTIONS

References

ResolveDefaultsModeConfigOptions

Re-exports ResolveDefaultsModeConfigOptions

resolveDefaultsModeConfig

Re-exports resolveDefaultsModeConfig

Variables

Const AWS_DEFAULTS_MODE_CONFIG

AWS_DEFAULTS_MODE_CONFIG: "defaults_mode" = "defaults_mode"

Const AWS_DEFAULTS_MODE_ENV

AWS_DEFAULTS_MODE_ENV: "AWS_DEFAULTS_MODE" = "AWS_DEFAULTS_MODE"

Const AWS_DEFAULT_REGION_ENV

AWS_DEFAULT_REGION_ENV: "AWS_DEFAULT_REGION" = "AWS_DEFAULT_REGION"

Const AWS_EXECUTION_ENV

AWS_EXECUTION_ENV: "AWS_EXECUTION_ENV" = "AWS_EXECUTION_ENV"

Const AWS_REGION_ENV

AWS_REGION_ENV: "AWS_REGION" = "AWS_REGION"

Const DEFAULTS_MODE_OPTIONS

DEFAULTS_MODE_OPTIONS: string[] = ["in-region", "cross-region", "mobile", "standard", "legacy"]

Const ENV_IMDS_DISABLED

ENV_IMDS_DISABLED: "AWS_EC2_METADATA_DISABLED" = "AWS_EC2_METADATA_DISABLED"

Const IMDS_REGION_PATH

IMDS_REGION_PATH: "/latest/meta-data/placement/region" = "/latest/meta-data/placement/region"

Functions

Const inferPhysicalRegion

inferPhysicalRegion(): Promise<string | undefined>

- Defined in packages/util-defaults-mode-node/src/resolveDefaultsModeConfig.ts:76
Infer the hosting app's physical region.

Returns Promise<string | undefined>

Const resolveDefaultsModeConfig

resolveDefaultsModeConfig(__namedParameters?: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>; region: string | Provider<string> }): Provider<ResolvedDefaultsMode>

- Defined in packages/util-defaults-mode-node/src/resolveDefaultsModeConfig.ts:33
Validate the defaultsMode configuration. If the value is set to "auto", it resolves the value to "in-region", "cross-region", or "standard".

default

"legacy"

internal

Parameters
- Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>; region: string | Provider<string> } = {}
  - defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>
  - region: string | Provider<string>
Returns Provider<ResolvedDefaultsMode>

Const resolveNodeDefaultsModeAuto

resolveNodeDefaultsModeAuto(clientRegion?: string | Provider<string>): Promise<ResolvedDefaultsMode>

- Defined in packages/util-defaults-mode-node/src/resolveDefaultsModeConfig.ts:57
Parameters
- Optional clientRegion: string | Provider<string>
Returns Promise<ResolvedDefaultsMode>

Object literals

Const NODE_DEFAULTS_MODE_CONFIG_OPTIONS

NODE_DEFAULTS_MODE_CONFIG_OPTIONS: object

default

default: "legacy" = "legacy"

configFileSelector

configFileSelector(profile: Profile): DefaultsMode

- Defined in packages/util-defaults-mode-node/src/defaultsModeConfig.ts:11
Parameters
- profile: Profile
Returns DefaultsMode

environmentVariableSelector

environmentVariableSelector(env: ProcessEnv): DefaultsMode

- Defined in packages/util-defaults-mode-node/src/defaultsModeConfig.ts:8
Parameters
- env: ProcessEnv
Returns DefaultsMode

@aws-sdk/util-defaults-mode-node

Usage

Index

References

Interfaces

Variables

Functions

Object literals

References

ResolveDefaultsModeConfigOptions

resolveDefaultsModeConfig

Variables

Const AWS_DEFAULTS_MODE_CONFIG

Const AWS_DEFAULTS_MODE_ENV

Const AWS_DEFAULT_REGION_ENV

Const AWS_EXECUTION_ENV

Const AWS_REGION_ENV

Const DEFAULTS_MODE_OPTIONS

Const ENV_IMDS_DISABLED

Const IMDS_REGION_PATH

Functions

Const inferPhysicalRegion

Returns Promise<string | undefined>

Const resolveDefaultsModeConfig

Parameters

Default value __namedParameters: { defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>; region: string | Provider<string> } = {}

defaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy" | Provider<DefaultsMode>

region: string | Provider<string>

Returns Provider<ResolvedDefaultsMode>

Const resolveNodeDefaultsModeAuto

Parameters

Optional clientRegion: string | Provider<string>

Returns Promise<ResolvedDefaultsMode>

Object literals

Const NODE_DEFAULTS_MODE_CONFIG_OPTIONS

default

configFileSelector

Parameters

profile: Profile

Returns DefaultsMode

environmentVariableSelector

Parameters

env: ProcessEnv

Returns DefaultsMode