Package software.amazon.awscdk.services.cognito.identitypool.alpha
Amazon Cognito Identity Pool Construct Library
---
The APIs of higher level constructs in this module are in developer preview before they become stable. We will only make breaking changes to address unforeseen API issues. Therefore, these APIs are not subject to Semantic Versioning, and breaking changes will be announced in release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
Identity Pools are in a separate module while the API is being stabilized. Once we stabilize the module, they will be included into the stable aws-cognito library. Please provide feedback on this experience by creating an issue here
Amazon Cognito Identity Pools enable you to grant your users access to other AWS services.
Identity Pools are one of the two main components of Amazon Cognito, which provides authentication, authorization, and user management for your web and mobile apps. Your users can sign in through a a trusted identity provider, like a user pool or a SAML 2.0 service, as well as with third party providers such as Facebook, Amazon, Google or Apple.
The other main component in Amazon Cognito is user pools. User Pools are user directories that provide sign-up and sign-in options for your app users.
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPool; import software.amazon.awscdk.services.cognito.identitypool.alpha.UserPoolAuthenticationProvider;
Table of Contents
Identity Pools
Identity pools provide temporary AWS credentials for users who are guests (unauthenticated) and for users who have authenticated by presenting a token from another identity provider. An identity pool is a store of user identity data specific to an account.
Identity pools can be used in conjunction with Cognito User Pools or by accessing external federated identity providers directly. Learn more at Amazon Cognito Identity Pools.
Authenticated and Unauthenticated Identities
Identity pools define two types of identities: authenticated(user
) and unauthenticated (guest
). Every identity in
an identity pool is either authenticated or unauthenticated. Each identity pool has a default role for authenticated
identities, and a default role for unauthenticated identities. Absent other overriding rules (see below), these are the
roles that will be assumed by the corresponding users in the authentication process.
A basic Identity Pool with minimal configuration has no required props, with default authenticated (user) and unauthenticated (guest) roles applied to the identity pool:
new IdentityPool(this, "myIdentityPool");
By default, both the authenticated and unauthenticated roles will have no permissions attached. When granting permissions,
you should ensure that you are granting the least privileged permissions required for your use case. Grant permissions
to roles using the public authenticatedRole
and unauthenticatedRole
properties:
import software.amazon.awscdk.services.dynamodb.*; Table table; IdentityPool identityPool = new IdentityPool(this, "myIdentityPool"); // Grant permissions to authenticated users table.grantReadWriteData(identityPool.getAuthenticatedRole()); // Grant permissions to unauthenticated guest users table.grantReadData(identityPool.getUnauthenticatedRole()); // Or add policy statements straight to the role identityPool.authenticatedRole.addToPrincipalPolicy(PolicyStatement.Builder.create() .effect(Effect.ALLOW) .actions(List.of("dynamodb:UpdateItem")) .resources(List.of(table.getTableArn())) .build());
The default roles can also be supplied in IdentityPoolProps
:
Stack stack = new Stack(); Role authenticatedRole = Role.Builder.create(this, "authRole") .assumedBy(new ServicePrincipal("service.amazonaws.com")) .build(); Role unauthenticatedRole = Role.Builder.create(this, "unauthRole") .assumedBy(new ServicePrincipal("service.amazonaws.com")) .build(); IdentityPool identityPool = IdentityPool.Builder.create(this, "TestIdentityPoolActions") .authenticatedRole(authenticatedRole) .unauthenticatedRole(unauthenticatedRole) .build();
Authentication Providers
Authenticated identities belong to users who are authenticated by a public login provider (Amazon Cognito user pools, Login with Amazon, Sign in with Apple, Facebook, Google, SAML, or any OpenID Connect Providers) or a developer provider (your own backend authentication process).
Authentication providers can be associated with an Identity Pool by first associating them with a Cognito User Pool or by associating the provider directly with the identity pool.
User Pool Authentication Provider
In order to attach a user pool to an identity pool as an authentication provider, the identity pool needs properties
from both the user pool and the user pool client. For this reason identity pools use a UserPoolAuthenticationProvider
to gather the necessary properties from the user pool constructs.
UserPool userPool = new UserPool(this, "Pool"); IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .authenticationProviders(IdentityPoolAuthenticationProviders.builder() .userPools(List.of(UserPoolAuthenticationProvider.Builder.create().userPool(userPool).build())) .build()) .build();
User pools can also be associated with an identity pool after instantiation. The Identity Pool's addUserPoolAuthentication
method
returns the User Pool Client that has been created:
IdentityPool identityPool; UserPool userPool = new UserPool(this, "Pool"); void userPoolClient = identityPool.addUserPoolAuthentication(UserPoolAuthenticationProvider.Builder.create() .userPool(userPool) .build());
Server Side Token Check
With the IdentityPool
CDK Construct, by default the pool is configured to check with the integrated user pools to
make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or
AWS credentials for the user.
If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error. This setting can be disabled, however, in several ways.
Setting disableServerSideTokenCheck
to true will change the default behavior to no server side token check. Learn
more here:
IdentityPool identityPool; UserPool userPool = new UserPool(this, "Pool"); identityPool.addUserPoolAuthentication(UserPoolAuthenticationProvider.Builder.create() .userPool(userPool) .disableServerSideTokenCheck(true) .build());
Associating an External Provider Directly
One or more external identity providers can be associated with an identity pool directly using
authenticationProviders
:
IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .authenticationProviders(IdentityPoolAuthenticationProviders.builder() .amazon(IdentityPoolAmazonLoginProvider.builder() .appId("amzn1.application.12312k3j234j13rjiwuenf") .build()) .facebook(IdentityPoolFacebookLoginProvider.builder() .appId("1234567890123") .build()) .google(IdentityPoolGoogleLoginProvider.builder() .clientId("12345678012.apps.googleusercontent.com") .build()) .apple(IdentityPoolAppleLoginProvider.builder() .servicesId("com.myappleapp.auth") .build()) .twitter(IdentityPoolTwitterLoginProvider.builder() .consumerKey("my-twitter-id") .consumerSecret("my-twitter-secret") .build()) .build()) .build();
To associate more than one provider of the same type with the identity pool, use User Pools, OpenIdConnect, or SAML. Only one provider per external service can be attached directly to the identity pool.
OpenId Connect and Saml
OpenID Connect is an open standard for authentication that is supported by a number of login providers. Amazon Cognito supports linking of identities with OpenID Connect providers that are configured through AWS Identity and Access Management.
An identity provider that supports Security Assertion Markup Language 2.0 (SAML 2.0) can be used to provide a simple onboarding flow for users. The SAML-supporting identity provider specifies the IAM roles that can be assumed by users so that different users can be granted different sets of permissions. Associating an OpenId Connect or Saml provider with an identity pool:
OpenIdConnectProvider openIdConnectProvider; SamlProvider samlProvider; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .authenticationProviders(IdentityPoolAuthenticationProviders.builder() .openIdConnectProviders(List.of(openIdConnectProvider)) .samlProviders(List.of(samlProvider)) .build()) .build();
Custom Providers
The identity pool's behavior can be customized further using custom developer authenticated identities. With developer authenticated identities, users can be registered and authenticated via an existing authentication process while still using Amazon Cognito to synchronize user data and access AWS resources.
Like the supported external providers, though, only one custom provider can be directly associated with the identity pool.
OpenIdConnectProvider openIdConnectProvider; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .authenticationProviders(IdentityPoolAuthenticationProviders.builder() .google(IdentityPoolGoogleLoginProvider.builder() .clientId("12345678012.apps.googleusercontent.com") .build()) .openIdConnectProviders(List.of(openIdConnectProvider)) .customProvider("my-custom-provider.example.com") .build()) .build();
Role Mapping
In addition to setting default roles for authenticated and unauthenticated users, identity pools can also be used to define rules to choose the role for each user based on claims in the user's ID token by using Role Mapping. When using role mapping, it's important to be aware of some of the permissions the role will need, and that the least privileged roles necessary are given for your specific use case. An in depth review of roles and role mapping can be found here.
Using a token-based approach to role mapping will allow mapped roles to be passed through the cognito:roles
or
cognito:preferred_role
claims from the identity provider:
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviderUrl; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .roleMappings(List.of(IdentityPoolRoleMapping.builder() .providerUrl(IdentityPoolProviderUrl.AMAZON) .useToken(true) .build())) .build();
Using a rule-based approach to role mapping allows roles to be assigned based on custom claims passed from the identity provider:
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviderUrl; import software.amazon.awscdk.services.cognito.identitypool.alpha.RoleMappingMatchType; Role adminRole; Role nonAdminRole; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") // Assign specific roles to users based on whether or not the custom admin claim is passed from the identity provider .roleMappings(List.of(IdentityPoolRoleMapping.builder() .providerUrl(IdentityPoolProviderUrl.AMAZON) .rules(List.of(RoleMappingRule.builder() .claim("custom:admin") .claimValue("admin") .mappedRole(adminRole) .build(), RoleMappingRule.builder() .claim("custom:admin") .claimValue("admin") .matchType(RoleMappingMatchType.NOTEQUAL) .mappedRole(nonAdminRole) .build())) .build())) .build();
Role mappings can also be added after instantiation with the Identity Pool's addRoleMappings
method:
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolRoleMapping; IdentityPool identityPool; IdentityPoolRoleMapping myAddedRoleMapping1; IdentityPoolRoleMapping myAddedRoleMapping2; IdentityPoolRoleMapping myAddedRoleMapping3; identityPool.addRoleMappings(myAddedRoleMapping1, myAddedRoleMapping2, myAddedRoleMapping3);
Provider Urls
Role mappings must be associated with the url of an Identity Provider which can be supplied
IdentityPoolProviderUrl
. Supported Providers have static Urls that can be used:
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviderUrl; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .roleMappings(List.of(IdentityPoolRoleMapping.builder() .providerUrl(IdentityPoolProviderUrl.FACEBOOK) .useToken(true) .build())) .build();
For identity providers that don't have static Urls, a custom Url can be supplied:
import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviderUrl; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .roleMappings(List.of(IdentityPoolRoleMapping.builder() .providerUrl(IdentityPoolProviderUrl.custom("my-custom-provider.com")) .useToken(true) .build())) .build();
If a provider URL is a CDK Token, as it will be if you are trying to use a previously defined Cognito User Pool, you will need to also provide a mappingKey. This is because by default, the key in the Cloudformation role mapping hash is the providerUrl, and Cloudformation map keys must be concrete strings, they cannot be references. For example:
import software.amazon.awscdk.services.cognito.UserPool; import software.amazon.awscdk.services.cognito.UserPoolClient; import software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviderUrl; UserPool userPool; UserPoolClient userPoolClient; IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .roleMappings(List.of(IdentityPoolRoleMapping.builder() .mappingKey("cognito") .providerUrl(IdentityPoolProviderUrl.userPool(userPool, userPoolClient)) .useToken(true) .build())) .build();
See here for more information.
Authentication Flow
Identity Pool Authentication Flow defaults to the enhanced, simplified flow. The Classic (basic) Authentication Flow
can also be implemented using allowClassicFlow
:
IdentityPool.Builder.create(this, "myidentitypool") .identityPoolName("myidentitypool") .allowClassicFlow(true) .build();
Cognito Sync
It's now recommended to integrate AWS AppSync for synchronizing app data across devices, so
Cognito Sync features like PushSync
, CognitoEvents
, and CognitoStreams
are not a part of IdentityPool
. More
information can be found here.
Importing Identity Pools
You can import existing identity pools into your stack using Identity Pool static methods with the Identity Pool Id or Arn:
IdentityPool.fromIdentityPoolId(this, "my-imported-identity-pool", "us-east-1:dj2823ryiwuhef937"); IdentityPool.fromIdentityPoolArn(this, "my-imported-identity-pool", "arn:aws:cognito-identity:us-east-1:123456789012:identitypool/us-east-1:dj2823ryiwuhef937");
-
ClassDescription(experimental) Define a Cognito Identity Pool.(experimental) A fluent builder for
IdentityPool
.(experimental) Login Provider for identity federation using Amazon credentials.A builder forIdentityPoolAmazonLoginProvider
An implementation forIdentityPoolAmazonLoginProvider
(experimental) Login Provider for identity federation using Apple credentials.A builder forIdentityPoolAppleLoginProvider
An implementation forIdentityPoolAppleLoginProvider
(experimental) External Authentication Providers for usage in Identity Pool.A builder forIdentityPoolAuthenticationProviders
An implementation forIdentityPoolAuthenticationProviders
(experimental) Login Provider for identity federation using Facebook credentials.A builder forIdentityPoolFacebookLoginProvider
An implementation forIdentityPoolFacebookLoginProvider
(experimental) Login Provider for identity federation using Google credentials.A builder forIdentityPoolGoogleLoginProvider
An implementation forIdentityPoolGoogleLoginProvider
(experimental) Props for the Identity Pool construct.A builder forIdentityPoolProps
An implementation forIdentityPoolProps
(experimental) Types of Identity Pool Login Providers.(experimental) Keys for Login Providers - each correspond to the client IDs of their respective federation Identity Providers.(experimental) Defines an Identity Pool Role Attachment.(experimental) A fluent builder forIdentityPoolRoleAttachment
.(experimental) Props for an Identity Pool Role Attachment.A builder forIdentityPoolRoleAttachmentProps
An implementation forIdentityPoolRoleAttachmentProps
(experimental) Map roles to users in the Identity Pool based on claims from the Identity Provider.A builder forIdentityPoolRoleMapping
An implementation forIdentityPoolRoleMapping
(experimental) Login Provider for identity federation using Twitter credentials.A builder forIdentityPoolTwitterLoginProvider
An implementation forIdentityPoolTwitterLoginProvider
(experimental) Represents a Cognito Identity Pool.Internal default implementation forIIdentityPool
.A proxy class which represents a concrete javascript instance of this type.(experimental) Represents an Identity Pool Role Attachment.Internal default implementation forIIdentityPoolRoleAttachment
.A proxy class which represents a concrete javascript instance of this type.(experimental) Represents the concept of a User Pool Authentication Provider.Internal default implementation forIUserPoolAuthenticationProvider
.A proxy class which represents a concrete javascript instance of this type.(experimental) Types of matches allowed for role mapping.(experimental) Represents an Identity Pool Role Attachment role mapping rule.A builder forRoleMappingRule
An implementation forRoleMappingRule
(experimental) Defines a User Pool Authentication Provider.(experimental) A fluent builder forUserPoolAuthenticationProvider
.(experimental) Represents a UserPoolAuthenticationProvider Bind Configuration.A builder forUserPoolAuthenticationProviderBindConfig
An implementation forUserPoolAuthenticationProviderBindConfig
(experimental) Represents UserPoolAuthenticationProvider Bind Options.A builder forUserPoolAuthenticationProviderBindOptions
An implementation forUserPoolAuthenticationProviderBindOptions
(experimental) Props for the User Pool Authentication Provider.A builder forUserPoolAuthenticationProviderProps
An implementation forUserPoolAuthenticationProviderProps