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

What is @aws-sdk/credential-provider-cognito-identity?

The @aws-sdk/credential-provider-cognito-identity package is part of the AWS SDK for JavaScript v3. It provides a way to retrieve AWS credentials and manage identity for applications using Amazon Cognito. This package is specifically designed to integrate with Amazon Cognito Identity Pools, allowing developers to authenticate users and grant them access to various AWS services.

What are @aws-sdk/credential-provider-cognito-identity's main functionalities?

Retrieve AWS Credentials

This feature allows developers to retrieve AWS credentials for authenticated or unauthenticated users from an Amazon Cognito Identity Pool. The credentials can then be used to access other AWS services.

import { fromCognitoIdentityPool } from '@aws-sdk/credential-provider-cognito-identity';
const credentials = fromCognitoIdentityPool({
  clientConfig: { region: 'us-west-2' },
  identityPoolId: 'us-west-2:12345678-1234-1234-1234-123456789012'
});

Customize Credential Behavior

Developers can specify a custom role ARN to define which IAM role the credentials should assume when accessing AWS services. This is useful for fine-grained control over permissions.

import { fromCognitoIdentityPool } from '@aws-sdk/credential-provider-cognito-identity';
const credentials = fromCognitoIdentityPool({
  clientConfig: { region: 'us-west-2' },
  identityPoolId: 'us-west-2:12345678-1234-1234-1234-123456789012',
  customRoleArn: 'arn:aws:iam::123456789012:role/MyCustomRole'
});

Other packages similar to @aws-sdk/credential-provider-cognito-identity

amazon-cognito-identity-js

This package provides authentication functionality for Amazon Cognito. It is similar to @aws-sdk/credential-provider-cognito-identity but focuses more broadly on user authentication rather than just credential provisioning. It supports features like user registration, authentication, and account recovery.

aws-amplify

AWS Amplify is a comprehensive development framework that includes support for Cognito Identity. While it provides similar functionalities for handling credentials and identities, it is more extensive, offering features for building complete applications including UI components, API interactions, and more.

README

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

An internal package

Usage

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

Changelog

3.662.0 (2024-10-01)

Bug Fixes

• s3-request-presigner: enable overriding hoistable headers (#6535) (3c2e59c)

Features

• client-bedrock-agent: This release adds support to stop an ongoing ingestion job using the StopIngestionJob API in Agents for Amazon Bedrock. (ac89806)
• client-codeartifact: Add support for the dual stack endpoints. (cb499b9)
• client-rds: This release provides additional support for enabling Aurora Limitless Database DB clusters. (b7b061d)
• clients: update client endpoints as of 2024-10-01 (15702eb)