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;
}

Properties

createCredentialManagerForRole getCallerIdentity getCredentialProvider getCredentials name

Properties

Readonly createCredentialManagerForRole

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

Create a new credential manager for the given command role.

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

Param: iamRoleArn

IAM role ARN

Returns

Credential provider

Readonly getCallerIdentity

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

Type declaration

Returns

Identity associated with the credentials

Readonly getCredentialProvider

getCredentialProvider: (() => AwsCredentialIdentityProvider)

Type declaration

    • (): AwsCredentialIdentityProvider

    • Returns AwsCredentialIdentityProvider

      CredentialProvider

Returns

CredentialProvider

Readonly getCredentials

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

Type declaration

    • (): Promise<AwsCredentialIdentity>

    • Returns Promise<AwsCredentialIdentity>

      AWS credentials

Returns

AWS credentials

Readonly name

name: string

Credential manager name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc