@aws-sdk/credential-provider-imds

An internal package

Usage

You probably shouldn't, at least directly. Please use @aws-sdk/credential-providers instead.

Index

Enumerations

Interfaces

Variables

Functions

Object literals

References

DEFAULT_MAX_RETRIES

Re-exports DEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRIES

Re-exports DEFAULT_MAX_RETRIES

DEFAULT_TIMEOUT

Re-exports DEFAULT_TIMEOUT

DEFAULT_TIMEOUT

Re-exports DEFAULT_TIMEOUT

ENV_CMDS_AUTH_TOKEN

Re-exports ENV_CMDS_AUTH_TOKEN

ENV_CMDS_FULL_URI

Re-exports ENV_CMDS_FULL_URI

ENV_CMDS_RELATIVE_URI

Re-exports ENV_CMDS_RELATIVE_URI

ImdsCredentials

Re-exports ImdsCredentials

InstanceMetadataCredentials

Re-exports InstanceMetadataCredentials

RemoteProviderConfig

Re-exports RemoteProviderConfig

RemoteProviderConfig

Re-exports RemoteProviderConfig

RemoteProviderInit

Re-exports RemoteProviderInit

RemoteProviderInit

Re-exports RemoteProviderInit

fromContainerMetadata

Re-exports fromContainerMetadata

fromImdsCredentials

Re-exports fromImdsCredentials

fromInstanceMetadata

Re-exports fromInstanceMetadata

getInstanceMetadataEndpoint

Re-exports getInstanceMetadataEndpoint

httpRequest

Re-exports httpRequest

isImdsCredentials

Re-exports isImdsCredentials

providerConfigFromInit

Re-exports providerConfigFromInit

providerConfigFromInit

Re-exports providerConfigFromInit

Variables

Const CMDS_IP

CMDS_IP: "169.254.170.2" = "169.254.170.2"

Const CONFIG_ENDPOINT_MODE_NAME

CONFIG_ENDPOINT_MODE_NAME: "ec2_metadata_service_endpoint_mode" = "ec2_metadata_service_endpoint_mode"

Const CONFIG_ENDPOINT_NAME

CONFIG_ENDPOINT_NAME: "ec2_metadata_service_endpoint" = "ec2_metadata_service_endpoint"

Const DEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRIES: 0 = 0

Const DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: 1000 = 1000

Const ENV_CMDS_AUTH_TOKEN

ENV_CMDS_AUTH_TOKEN: "AWS_CONTAINER_AUTHORIZATION_TOKEN" = "AWS_CONTAINER_AUTHORIZATION_TOKEN"

Const ENV_CMDS_FULL_URI

ENV_CMDS_FULL_URI: "AWS_CONTAINER_CREDENTIALS_FULL_URI" = "AWS_CONTAINER_CREDENTIALS_FULL_URI"

Const ENV_CMDS_RELATIVE_URI

ENV_CMDS_RELATIVE_URI: "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"

Const ENV_ENDPOINT_MODE_NAME

ENV_ENDPOINT_MODE_NAME: "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE" = "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE"

Const ENV_ENDPOINT_NAME

ENV_ENDPOINT_NAME: "AWS_EC2_METADATA_SERVICE_ENDPOINT" = "AWS_EC2_METADATA_SERVICE_ENDPOINT"

Const IMDS_PATH

IMDS_PATH: "/latest/meta-data/iam/security-credentials/" = "/latest/meta-data/iam/security-credentials/"

Const IMDS_TOKEN_PATH

IMDS_TOKEN_PATH: "/latest/api/token" = "/latest/api/token"

Const STATIC_STABILITY_DOC_URL

STATIC_STABILITY_DOC_URL: "https://docs.aws.amazon.com/sdkref/latest/guide/feature-static-credentials.html" = "https://docs.aws.amazon.com/sdkref/latest/guide/feature-static-credentials.html"

Const STATIC_STABILITY_REFRESH_INTERVAL_JITTER_WINDOW_SECONDS

STATIC_STABILITY_REFRESH_INTERVAL_JITTER_WINDOW_SECONDS: number = 5 * 60

Const STATIC_STABILITY_REFRESH_INTERVAL_SECONDS

STATIC_STABILITY_REFRESH_INTERVAL_SECONDS: number = 5 * 60

Functions

Const fromContainerMetadata

fromContainerMetadata(init?: RemoteProviderInit): CredentialProvider

- Defined in packages/credential-provider-imds/src/fromContainerMetadata.ts:19
Creates a credential provider that will source credentials from the ECS Container Metadata Service

Parameters
- Default value init: RemoteProviderInit = {}
Returns CredentialProvider

Const fromImdsCredentials

fromImdsCredentials(creds: ImdsCredentials): Credentials

- Defined in packages/credential-provider-imds/src/remoteProvider/ImdsCredentials.ts:18
Parameters
- creds: ImdsCredentials
Returns Credentials

Const fromInstanceMetadata

fromInstanceMetadata(init?: RemoteProviderInit): Provider<InstanceMetadataCredentials>

- Defined in packages/credential-provider-imds/src/fromInstanceMetadata.ts:20
Creates a credential provider that will source credentials from the EC2 Instance Metadata Service

Parameters
- Default value init: RemoteProviderInit = {}
Returns Provider<InstanceMetadataCredentials>

Const getCmdsUri

getCmdsUri(): Promise<RequestOptions>

- Defined in packages/credential-provider-imds/src/fromContainerMetadata.ts:57
Returns Promise<RequestOptions>

Const getCredentialsFromProfile

getCredentialsFromProfile(profile: string, options: RequestOptions): Promise<Credentials>

- Defined in packages/credential-provider-imds/src/fromInstanceMetadata.ts:99
Parameters
- profile: string
- options: RequestOptions
Returns Promise<Credentials>

Const getExtendedInstanceMetadataCredentials

getExtendedInstanceMetadataCredentials(credentials: InstanceMetadataCredentials, logger: Logger): InstanceMetadataCredentials

- Defined in packages/credential-provider-imds/src/utils/getExtendedInstanceMetadataCredentials.ts:9
Parameters
- credentials: InstanceMetadataCredentials
- logger: Logger
Returns InstanceMetadataCredentials

Const getFromEndpointConfig

getFromEndpointConfig(): Promise<string | undefined>

- Defined in packages/credential-provider-imds/src/utils/getInstanceMetadataEndpoint.ts:36
Returns Promise<string | undefined>

Const getFromEndpointModeConfig

getFromEndpointModeConfig(): Promise<string>

- Defined in packages/credential-provider-imds/src/utils/getInstanceMetadataEndpoint.ts:38
Returns Promise<string>

Const getInstanceImdsProvider

getInstanceImdsProvider(init: RemoteProviderInit): (Anonymous function)

- Defined in packages/credential-provider-imds/src/fromInstanceMetadata.ts:23
Parameters
- init: RemoteProviderInit
Returns (Anonymous function)

Const getInstanceMetadataEndpoint

getInstanceMetadataEndpoint(): Promise<Endpoint>

- Defined in packages/credential-provider-imds/src/utils/getInstanceMetadataEndpoint.ts:33
Returns the host to use for instance metadata service call.

The host is read from endpoint which can be set either in ENV_ENDPOINT_NAME environment variable or CONFIG_ENDPOINT_NAME configuration property.

If endpoint is not set, then endpoint mode is read either from ENV_ENDPOINT_MODE_NAME environment variable or CONFIG_ENDPOINT_MODE_NAME configuration property. If endpoint mode is not set, then default endpoint mode EndpointMode.IPv4 is used.

If endpoint mode is set to EndpointMode.IPv4, then the host is Endpoint.IPv4. If endpoint mode is set to EndpointMode.IPv6, then the host is Endpoint.IPv6.

internal

Returns Promise<Endpoint>

Host to use for instance metadata service call.

Const getMetadataToken

getMetadataToken(options: RequestOptions): Promise<Buffer>

- Defined in packages/credential-provider-imds/src/fromInstanceMetadata.ts:87
Parameters
- options: RequestOptions
Returns Promise<Buffer>

Const getProfile

getProfile(options: RequestOptions): Promise<string>

- Defined in packages/credential-provider-imds/src/fromInstanceMetadata.ts:97
Parameters
- options: RequestOptions
Returns Promise<string>

httpRequest

httpRequest(options: RequestOptions): Promise<Buffer>

- Defined in packages/credential-provider-imds/src/remoteProvider/httpRequest.ts:8
internal

Parameters
- options: RequestOptions
Returns Promise<Buffer>

Const isImdsCredentials

isImdsCredentials(arg: any): arg is ImdsCredentials

- Defined in packages/credential-provider-imds/src/remoteProvider/ImdsCredentials.ts:10
Parameters
- arg: any
Returns arg is ImdsCredentials

Const providerConfigFromInit

providerConfigFromInit(__namedParameters: { maxRetries: number; timeout: number }): RemoteProviderConfig

- Defined in packages/credential-provider-imds/src/remoteProvider/RemoteProviderInit.ts:25
Parameters
- __namedParameters: { maxRetries: number; timeout: number }
  - maxRetries: number
  - timeout: number
Returns RemoteProviderConfig

Const requestFromEcsImds

requestFromEcsImds(timeout: number, options: RequestOptions): Promise<string>

- Defined in packages/credential-provider-imds/src/fromContainerMetadata.ts:32
Parameters
- timeout: number
- options: RequestOptions
Returns Promise<string>

Const retry

retry<T>(toRetry: RetryableProvider<T>, maxRetries: number): Promise<T>

- Defined in packages/credential-provider-imds/src/remoteProvider/retry.ts:8
internal

Type parameters
- T
Parameters
- toRetry: RetryableProvider<T>
- maxRetries: number
Returns Promise<T>

Const staticStabilityProvider

staticStabilityProvider(provider: Provider<InstanceMetadataCredentials>, options?: { logger?: Logger }): Provider<InstanceMetadataCredentials>

- Defined in packages/credential-provider-imds/src/utils/staticStabilityProvider.ts:15
IMDS credential supports static stability feature. When used, the expiration of recently issued credentials is extended. The server side allows using the recently expired credentials. This mitigates impact when clients using refreshable credentials are unable to retrieve updates.

Parameters
- provider: Provider<InstanceMetadataCredentials>
  
  Credential provider
- Default value options: { logger?: Logger } = {}
  - Optional logger?: Logger
Returns Provider<InstanceMetadataCredentials>

A credential provider that supports static stability

Object literals

Const ENDPOINT_CONFIG_OPTIONS

ENDPOINT_CONFIG_OPTIONS: object

default

default: undefined = undefined

configFileSelector

configFileSelector(profile: Profile): string

- Defined in packages/credential-provider-imds/src/config/EndpointConfigOptions.ts:8
Parameters
- profile: Profile
Returns string

environmentVariableSelector

environmentVariableSelector(env: ProcessEnv): string

- Defined in packages/credential-provider-imds/src/config/EndpointConfigOptions.ts:7
Parameters
- env: ProcessEnv
Returns string

Const ENDPOINT_MODE_CONFIG_OPTIONS

ENDPOINT_MODE_CONFIG_OPTIONS: object

default

default: EndpointMode = EndpointMode.IPv4

configFileSelector

configFileSelector(profile: Profile): string

- Defined in packages/credential-provider-imds/src/config/EndpointModeConfigOptions.ts:10
Parameters
- profile: Profile
Returns string

environmentVariableSelector

environmentVariableSelector(env: ProcessEnv): string

- Defined in packages/credential-provider-imds/src/config/EndpointModeConfigOptions.ts:9
Parameters
- env: ProcessEnv
Returns string

Const GREENGRASS_HOSTS

GREENGRASS_HOSTS: object

127.0.0.1

127.0.0.1: boolean = true

localhost

localhost: boolean = true

Const GREENGRASS_PROTOCOLS

GREENGRASS_PROTOCOLS: object

http:

http:: boolean = true

https:

https:: boolean = true

@aws-sdk/credential-provider-imds

Usage

Index

References

Enumerations

Interfaces

Variables

Functions

Object literals

References

DEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRIES

DEFAULT_TIMEOUT

DEFAULT_TIMEOUT

ENV_CMDS_AUTH_TOKEN

ENV_CMDS_FULL_URI

ENV_CMDS_RELATIVE_URI

ImdsCredentials

InstanceMetadataCredentials

RemoteProviderConfig

RemoteProviderConfig

RemoteProviderInit

RemoteProviderInit

fromContainerMetadata

fromImdsCredentials

fromInstanceMetadata

getInstanceMetadataEndpoint

httpRequest

isImdsCredentials

providerConfigFromInit

providerConfigFromInit

Variables

Const CMDS_IP

Const CONFIG_ENDPOINT_MODE_NAME

Const CONFIG_ENDPOINT_NAME

Const DEFAULT_MAX_RETRIES

Const DEFAULT_TIMEOUT

Const ENV_CMDS_AUTH_TOKEN

Const ENV_CMDS_FULL_URI

Const ENV_CMDS_RELATIVE_URI

Const ENV_ENDPOINT_MODE_NAME

Const ENV_ENDPOINT_NAME

Const IMDS_PATH

Const IMDS_TOKEN_PATH

Const STATIC_STABILITY_DOC_URL

Const STATIC_STABILITY_REFRESH_INTERVAL_JITTER_WINDOW_SECONDS

Const STATIC_STABILITY_REFRESH_INTERVAL_SECONDS

Functions

Const fromContainerMetadata

Parameters

Default value init: RemoteProviderInit = {}

Returns CredentialProvider

Const fromImdsCredentials

Parameters

creds: ImdsCredentials

Returns Credentials

Const fromInstanceMetadata

Parameters

Default value init: RemoteProviderInit = {}

Returns Provider<InstanceMetadataCredentials>

Const getCmdsUri

Returns Promise<RequestOptions>

Const getCredentialsFromProfile

Parameters

profile: string

options: RequestOptions

Returns Promise<Credentials>

Const getExtendedInstanceMetadataCredentials

Parameters

credentials: InstanceMetadataCredentials

logger: Logger

Returns InstanceMetadataCredentials

Const getFromEndpointConfig

Returns Promise<string | undefined>

Const getFromEndpointModeConfig

Returns Promise<string>

Const getInstanceImdsProvider

Parameters

init: RemoteProviderInit

Returns (Anonymous function)