@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.691.0 (2024-11-13)

Features

• client-accessanalyzer: This release adds support for policy validation and external access findings for resource control policies (RCP). IAM Access Analyzer helps you author functional and secure RCPs and awareness that a RCP may restrict external access. Updated service API, documentation, and paginators. (8ee2e53)
• client-application-signals: Amazon CloudWatch Application Signals now supports creating Service Level Objectives with burn rates. Users can now create or update SLOs with burn rate configurations to meet their specific business requirements. (e176892)
• client-b2bi: This release adds a GenerateMapping API to allow generation of JSONata or XSLT transformer code based on input and output samples. (79297bb)
• client-billing: Today, AWS announces the general availability of ListBillingViews API in the AWS SDKs, to enable AWS Billing Conductor (ABC) users to create proforma Cost and Usage Reports (CUR) programmatically. (b46415d)
• client-cloudtrail: This release adds a new API GenerateQuery that generates a query from a natural language prompt about the event data in your event data store. This operation uses generative artificial intelligence (generative AI) to produce a ready-to-use SQL query from the prompt. (93b16b2)
• client-dynamodb: This release includes supports the new WarmThroughput feature for DynamoDB. You can now provide an optional WarmThroughput attribute for CreateTable or UpdateTable APIs to pre-warm your table or global secondary index. You can also use DescribeTable to see the latest WarmThroughput value. (0ca3c21)
• client-ec2: This release adds the source AMI details in DescribeImages API (67fa666)
• client-internetmonitor: Add new query type Routing_Suggestions regarding querying interface (4f49de2)
• client-mediaconvert: This release adds support for ARN inputs in the Kantar credentials secrets name field and the MSPR field to the manifests for PlayReady DRM protected outputs. (6c46bda)
• client-organizations: Add support for policy operations on the Resource Control Polices. (d87a984)
• clients: update client endpoints as of 2024-11-13 (24e23f9)