@aws-sdk/credential-provider-node

Functions

• defaultProvider()

Type Aliases

• DefaultProviderInit

function defaultProvider

defaultProvider: (
    init?: DefaultProviderInit
) => MemoizedProvider<AwsCredentialIdentity>;

• Creates a credential provider that will attempt to find credentials from the following sources (listed in order of precedence): * Environment variables exposed via process.env * SSO credentials from token cache * Web identity token credentials * Shared credentials and config ini files * The EC2/ECS Instance Metadata Service

  The default credential provider will invoke one provider at a time and only continue to the next if no credentials have been located. For example, if the process finds values defined via the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, the files at ~/.aws/credentials and ~/.aws/config will not be read, nor will any messages be sent to the Instance Metadata Service.

  Parameter init

  Configuration that is passed to each individual provider

  See Also

  • fromEnv The function used to source credentials from environment variables

  • fromSSO The function used to source credentials from resolved SSO token cache

  • fromTokenFile The function used to source credentials from token file

  • fromIni The function used to source credentials from INI files

  • fromProcess The function used to sources credentials from credential_process in INI files

  • fromInstanceMetadata The function used to source credentials from the EC2 Instance Metadata Service

  • fromContainerMetadata The function used to source credentials from the ECS Container Metadata Service

type DefaultProviderInit

type DefaultProviderInit = FromIniInit &
    RemoteProviderInit &
    FromProcessInit &
    FromSSOInit &
    FromTokenFileInit;