Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional configFilepath

configFilepath: string

The path at which to locate the ini config file. Defaults to the value of the AWS_CONFIG_FILE environment variable (if defined) or ~/.aws/config otherwise.

Optional filepath

filepath: string

The path at which to locate the ini credentials file. Defaults to the value of the AWS_SHARED_CREDENTIALS_FILE environment variable (if defined) or ~/.aws/credentials otherwise.

Optional mfaCodeProvider

mfaCodeProvider: (mfaSerial: string) => Promise<string>

A function that returns a promise fulfilled with an MFA token code for the provided MFA Serial code. If a profile requires an MFA code and mfaCodeProvider is not a valid function, the credential provider promise will be rejected.

param

The serial code of the MFA device specified.

Type declaration

    • (mfaSerial: string): Promise<string>
    • Parameters

      • mfaSerial: string

      Returns Promise<string>

Optional profile

profile: string

The configuration profile to use.

Optional roleAssumer

roleAssumer: (sourceCreds: Credentials, params: AssumeRoleParams) => Promise<Credentials>

A function that assumes a role and returns a promise fulfilled with credentials for the assumed role.

param

The credentials with which to assume a role.

param

Type declaration

Optional roleAssumerWithWebIdentity

roleAssumerWithWebIdentity: (params: AssumeRoleWithWebIdentityParams) => Promise<Credentials>

A function that assumes a role with web identity and returns a promise fulfilled with credentials for the assumed role.

param

The credentials with which to assume a role.

param

Type declaration