Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FromIniInit

Hierarchy

Index

Properties

Properties

Optional configFilepath

configFilepath: undefined | 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: undefined | 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 ignoreCache

ignoreCache: undefined | false | true

Configuration files are normally cached after the first time they are loaded. When this property is set, the provider will always reload any configuration files loaded before.

Optional mfaCodeProvider

mfaCodeProvider: undefined | ((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.

Optional profile

profile: undefined | string

The configuration profile to use.

Optional roleAssumer

roleAssumer: undefined | ((sourceCreds: AwsCredentialIdentity, params: AssumeRoleParams) => Promise<AwsCredentialIdentity>)

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

Optional roleAssumerWithWebIdentity

roleAssumerWithWebIdentity: undefined | ((params: AssumeRoleWithWebIdentityParams) => Promise<AwsCredentialIdentity>)

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