@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.614.0 (2024-07-10)

Bug Fixes

• util-dynamodb: perform global interface check in NativeAttributeBinary union (#6261) (e116b4c)

Features

• client-batch: This feature allows AWS Batch Jobs with EKS container orchestration type to be run as Multi-Node Parallel Jobs. (bda616d)
• client-bedrock-agent-runtime: Introduces query decomposition, enhanced Agents integration with Knowledge bases, session summary generation, and code interpretation (preview) for Claude V3 Sonnet and Haiku models. Also introduces Prompt Flows (preview) to link prompts, foundational models, and resources for end-to-end solutions. (f2f40c1)
• client-bedrock-agent: Introduces new data sources and chunking strategies for Knowledge bases, advanced parsing logic using FMs, session summary generation, and code interpretation (preview) for Claude V3 Sonnet and Haiku models. Also introduces Prompt Flows (preview) to link prompts, foundational models, and resources. (6d701b1)
• client-bedrock-runtime: Add support for contextual grounding check and ApplyGuardrail API for Guardrails for Amazon Bedrock. (8863b77)
• client-bedrock: Add support for contextual grounding check for Guardrails for Amazon Bedrock. (f8cc6bd)
• client-ec2: Add parameters to enable provisioning IPAM BYOIPv4 space at a Local Zone Network Border Group level (d835dbb)
• client-glue: Add recipe step support for recipe node (c9d85d8)
• client-license-manager-linux-subscriptions: Add support for third party subscription providers, starting with RHEL subscriptions through Red Hat Subscription Manager (RHSM). Additionally, add support for tagging subscription provider resources, and detect when an instance has more than one Linux subscription and notify the customer. (e490334)
• client-mediaconnect: AWS Elemental MediaConnect introduces the ability to disable outputs. Disabling an output allows you to keep the output attached to the flow, but stop streaming to the output destination. A disabled output does not incur data transfer costs. (427a732)
• clients: update client endpoints as of 2024-07-10 (3a748e5)