@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.554.0 (2024-04-11)

Bug Fixes

• private: add dependency checking to private folder (#5993) (c071cea)

Features

• client-batch: This release adds the task properties field to attempt details and the name field on EKS container detail. (6771613)
• client-cloudfront: CloudFront origin access control extends support to AWS Lambda function URLs and AWS Elemental MediaPackage v2 origins. (1061555)
• client-cloudwatch: This release adds support for Metric Characteristics for CloudWatch Anomaly Detection. Anomaly Detector now takes Metric Characteristics object with Periodic Spikes boolean field that tells Anomaly Detection that spikes that repeat at the same time every week are part of the expected pattern. (e0d291a)
• client-iam: For CreateOpenIDConnectProvider API, the ThumbprintList parameter is no longer required. (bd8d5bf)
• client-medialive: AWS Elemental MediaLive introduces workflow monitor, a new feature that enables the visualization and monitoring of your media workflows. Create signal maps of your existing workflows and monitor them by creating notification and monitoring template groups. (17570f0)
• client-omics: This release adds support for retrieval of S3 direct access metadata on sequence stores and read sets, and adds support for SHA256up and SHA512up HealthOmics ETags. (a6d5127)
• client-pipes: LogConfiguration ARN validation fixes (b937f44)
• client-wafv2: Adds an updated version of smoke tests, including smithy trait, for SDK testing. (5b79451)
• clients: update client endpoints as of 2024-04-11 (bd1a417)
• core: validate XML during deserialization (#5991) (50002cf)