Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/credential-provider-cognito-identity

@aws-sdk/credential-provider-cognito-identity

NPM version NPM downloads

An internal package

Usage

You probably shouldn't, at least directly. Please use @aws-sdk/credential-providers instead.

Index

References

Classes

Interfaces

Type aliases

Variables

Functions

References

CognitoIdentityCredentialProvider

Re-exports CognitoIdentityCredentialProvider

CognitoIdentityCredentials

Re-exports CognitoIdentityCredentials

CognitoProviderParameters

Re-exports CognitoProviderParameters

FromCognitoIdentityParameters

Re-exports FromCognitoIdentityParameters

FromCognitoIdentityPoolParameters

Re-exports FromCognitoIdentityPoolParameters

Logins

Re-exports Logins

ResolvedLogins

Re-exports ResolvedLogins

Storage

Re-exports Storage

fromCognitoIdentity

Re-exports fromCognitoIdentity

fromCognitoIdentityPool

Re-exports fromCognitoIdentityPool

Type aliases

CognitoIdentityCredentialProvider

CognitoIdentityCredentialProvider: Provider<CognitoIdentityCredentials>

Logins

Logins: Record<string, string | Provider<string>>

ResolvedLogins

ResolvedLogins: Record<string, string>

Variables

Const STORE_NAME

STORE_NAME: "IdentityIds" = "IdentityIds"

Const inMemoryStorage

inMemoryStorage: InMemoryStorage = new InMemoryStorage()

Functions

fromCognitoIdentity

fromCognitoIdentityPool

  • fromCognitoIdentityPool(__namedParameters: { accountId: string; cache: Storage; client: CognitoIdentityClient; customRoleArn: string; identityPoolId: string; logins: Logins; userIdentifier: string }): CognitoIdentityCredentialProvider

  • Retrieves or generates a unique identifier using Amazon Cognito's GetId operation, then generates temporary AWS credentials using Amazon Cognito's GetCredentialsForIdentity operation.

    Results from GetId are cached internally, but results from GetCredentialsForIdentity are not.

    Parameters

    • __namedParameters: { accountId: string; cache: Storage; client: CognitoIdentityClient; customRoleArn: string; identityPoolId: string; logins: Logins; userIdentifier: string }
      • accountId: string
      • cache: Storage
      • client: CognitoIdentityClient
      • customRoleArn: string
      • identityPoolId: string
      • logins: Logins
      • userIdentifier: string

    Returns CognitoIdentityCredentialProvider

localStorage

resolveLogins

throwOnMissingAccessKeyId

  • throwOnMissingAccessKeyId(): never

throwOnMissingCredentials

  • throwOnMissingCredentials(): never

throwOnMissingId

  • throwOnMissingId(): never

throwOnMissingSecretKey

  • throwOnMissingSecretKey(): never