Class InstancePrincipalsAuthenticationDetailsProvider

Hierarchy

AbstractRequestingAuthenticationDetailsProvider
- InstancePrincipalsAuthenticationDetailsProvider

Implements

Constructors

constructor

Properties

Methods

Constructors

constructor

new InstancePrincipalsAuthenticationDetailsProvider(federationClient: FederationClient, sessionKeySupplier: SessionKeySupplier, region: Region): InstancePrincipalsAuthenticationDetailsProvider

Overrides AbstractRequestingAuthenticationDetailsProvider.constructor
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:17
Parameters
- federationClient: FederationClient
- sessionKeySupplier: SessionKeySupplier
- region: Region
Returns InstancePrincipalsAuthenticationDetailsProvider

Properties

Protected federationClient

federationClient: FederationClient

Protected region

region: Region

Protected sessionKeySupplier

sessionKeySupplier: SessionKeySupplier

Methods

getKeyId

getKeyId(): Promise<string>

Implementation of AuthenticationDetailsProvider.getKeyId

Inherited from AbstractRequestingAuthenticationDetailsProvider.getKeyId
- Defined in lib/common/lib/auth/abstract-requesting-authentication-detail-provider.ts:20
Returns Promise<string>

getPassphrase

getPassphrase(): null

Implementation of AuthenticationDetailsProvider.getPassphrase

Inherited from AbstractRequestingAuthenticationDetailsProvider.getPassphrase
- Defined in lib/common/lib/auth/abstract-requesting-authentication-detail-provider.ts:28
Returns null

getPrivateKey

getPrivateKey(): string

Implementation of AuthenticationDetailsProvider.getPrivateKey

Inherited from AbstractRequestingAuthenticationDetailsProvider.getPrivateKey
- Defined in lib/common/lib/auth/abstract-requesting-authentication-detail-provider.ts:24
Returns string

getRegion

getRegion(): Region

Implementation of RegionProvider.getRegion
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:34
Returns Region

refresh

refresh(): Promise<string>

Implementation of RefreshableOnNotAuthenticatedProvider.refresh
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:29
Refreshes the authentication data used by the provider

Returns Promise<string>

the refreshed authentication data

Static builder

builder(): InstancePrincipalsAuthenticationDetailsProviderBuilder

- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:42
Creates a new InstancePrincipalsAuthenticationDetailsProviderBuilder.

Returns InstancePrincipalsAuthenticationDetailsProviderBuilder

A new builder instance.