Interface CredentialManager

Provides AWS credentials that can be used to invoke AWS APIs.

interface CredentialManager {
    createCredentialManagerForRole: ((iamRoleArn) => Promise<CredentialManager>);
    getCallerIdentity: (() => Promise<CallerIdentity>);
    getCredentialProvider: (() => AwsCredentialIdentityProvider);
    getCredentials: (() => Promise<AwsCredentialIdentity>);
    name: string;
}

Index

Properties

createCredentialManagerForRole getCallerIdentity getCredentialProvider getCredentials name

Properties

`Readonly` createCredentialManagerForRole

createCredentialManagerForRole: ((iamRoleArn) => Promise<CredentialManager>)

Type declaration

- (iamRoleArn): Promise<CredentialManager>
- Create a new credential manager for the given command role.
  Parameters
  - iamRoleArn: string
    IAM role ARN
  Returns Promise<CredentialManager>
  Credential provider

`Readonly` getCallerIdentity

getCallerIdentity: (() => Promise<CallerIdentity>)

Type declaration

- (): Promise<CallerIdentity>
- Returns Promise<CallerIdentity>
  Identity associated with the credentials

`Readonly` getCredentialProvider

getCredentialProvider: (() => AwsCredentialIdentityProvider)

Type declaration

- (): AwsCredentialIdentityProvider
- Returns AwsCredentialIdentityProvider
  CredentialProvider

`Readonly` getCredentials

getCredentials: (() => Promise<AwsCredentialIdentity>)

Type declaration

- (): Promise<AwsCredentialIdentity>
- Returns Promise<AwsCredentialIdentity>
  AWS credentials

`Readonly` name

name: string

Credential manager name

Generated using TypeDoc