Package software.amazon.awscdk.services.cognito

package software.amazon.awscdk.services.cognito

Amazon Cognito Construct Library

Amazon Cognito provides authentication, authorization, and user management for your web and mobile apps. Your users can sign in directly with a user name and password, or through a third party such as Facebook, Amazon, Google or Apple.

The two main components of Amazon Cognito are user pools and identity pools. User pools are user directories that provide sign-up and sign-in options for your app users. Identity pools enable you to grant your users access to other AWS services. Identity Pool L2 Constructs can be found here.

This module is part of the AWS Cloud Development Kit project.

Table of Contents

User Pools

User pools allow creating and managing your own directory of users that can sign up and sign in. They enable easy integration with social identity providers such as Facebook, Google, Amazon, Microsoft Active Directory, etc. through SAML.

Using the CDK, a new user pool can be created as part of the stack using the construct's constructor. You may specify the userPoolName to give your own identifier to the user pool. If not, CloudFormation will generate a name. 

 UserPool.Builder.create(this, "myuserpool")
         .userPoolName("myawesomeapp-userpool")
         .signInCaseSensitive(false)
         .build();

By default, usernames and email addresses in user pools are case sensitive, which means user@example.com and User@example.com are considered different. In most situations it is preferred to have usernames and email addresses be case insensitive so that capitalization differences are ignored. As shown above, you can make a user pool case insensitive by setting signInCaseSensitive to false. The case sensitivity cannot be changed once a user pool is created.

The default set up for the user pool is configured such that only administrators will be allowed to create users. Features such as Multi-factor authentication (MFAs) and Lambda Triggers are not configured by default.

Use the grant() method to add an IAM policy statement associated with the user pool to an IAM principal's policy. 

 UserPool userPool = new UserPool(this, "myuserpool");
 Role role = Role.Builder.create(this, "role")
         .assumedBy(new ServicePrincipal("foo"))
         .build();
 userPool.grant(role, "cognito-idp:AdminCreateUser");

User pool feature plans

Amazon Cognito has feature plans for user pools. Each plan has a set of features and a monthly cost per active user. Each feature plan unlocks access to more features than the one before it. Learn more about feature plans here.

  • Lite - a low-cost feature plan for user pools with lower numbers of monthly active users.
  • Essentials - all of the latest user pool authentication features.
  • Plus - includes everything in the Essentials plan and adds advanced security features that protect your users.

The default feature plan is Essentials for newly create user pools. For the existing user pools, Lite plan is automatically set.

Previously, some user pool features were included in an advanced security features pricing structure. The features that were included in this structure are now under either the Essentials or Plus plan.

Sign Up

Users can either be signed up by the app's administrators or can sign themselves up. Once a user has signed up, their account needs to be confirmed. Cognito provides several ways to sign users up and confirm their accounts. Learn more about user sign up here.

To verify the email address of a user in your user pool with Amazon Cognito, you can send the user an email message with a link that they can select, or you can send them a code that they can enter.

Code Verification

When a user signs up, email and SMS messages are used to verify their account and contact methods. The following code snippet configures a user pool with properties relevant to these verification messages - 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .selfSignUpEnabled(true)
         .userVerification(UserVerificationConfig.builder()
                 .emailSubject("Verify your email for our awesome app!")
                 .emailBody("Thanks for signing up to our awesome app! Your verification code is {####}")
                 .emailStyle(VerificationEmailStyle.CODE)
                 .smsMessage("Thanks for signing up to our awesome app! Your verification code is {####}")
                 .build())
         .build();

By default, self sign up is disabled. Learn more about email and SMS verification messages here.

Besides users signing themselves up, an administrator of any user pool can sign users up. The user then receives an invitation to join the user pool. The following code snippet configures a user pool with properties relevant to the invitation messages - 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .userInvitation(UserInvitationConfig.builder()
                 .emailSubject("Invite to join our awesome app!")
                 .emailBody("Hello {username}, you have been invited to join our awesome app! Your temporary password is {####}")
                 .smsMessage("Hello {username}, your temporary password for our awesome app is {####}")
                 .build())
         .build();

Alternatively, users can use link as a verification method. The following code snippet configures a user pool with properties relevant to these verification messages and link verification method. 

 UserPool.Builder.create(this, "myuserpool")
         .userVerification(UserVerificationConfig.builder()
                 .emailStyle(VerificationEmailStyle.LINK)
                 .emailSubject("Invite to join our awesome app!")
                 .emailBody("You have been invited to join our awesome app! {##Verify Your Email##}")
                 .build())
         .build();

All email subjects, bodies and SMS messages for both invitation and verification support Cognito's message templating. Learn more about message templates here.

Sign In

Users registering or signing in into your application can do so with multiple identifiers. There are 4 options available:

  • username: Allow signing in using the one time immutable user name that the user chose at the time of sign up.
  • email: Allow signing in using the email address that is associated with the account.
  • phone: Allow signing in using the phone number that is associated with the account.
  • preferredUsername: Allow signing in with an alternate user name that the user can change at any time. However, this is not available if the username option is not chosen.

The following code sets up a user pool so that the user can sign in with either their username or their email address - 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         // ...
         .signInAliases(SignInAliases.builder()
                 .username(true)
                 .email(true)
                 .build())
         .build();

User pools can either be configured so that user name is primary sign in form, but also allows for the other three to be used additionally; or it can be configured so that email and/or phone numbers are the only ways a user can register and sign in. Read more about this here.

⚠️ The Cognito service prevents changing the signInAlias property for an existing user pool.

To match with 'Option 1' in the above link, with a verified email, signInAliases should be set to { username: true, email: true }. To match with 'Option 2' in the above link with both a verified email and phone number, this property should be set to { email: true, phone: true }.

Cognito recommends that email and phone number be automatically verified, if they are one of the sign in methods for the user pool. Read more about that here. The CDK does this by default, when email and/or phone number are specified as part of signInAliases. This can be overridden by specifying the autoVerify property.

The following code snippet sets up only email as a sign in alias, but both email and phone number to be auto-verified. 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         // ...
         .signInAliases(SignInAliases.builder().username(true).email(true).build())
         .autoVerify(AutoVerifiedAttrs.builder().email(true).phone(true).build())
         .build();

A user pool can optionally ignore case when evaluating sign-ins. When signInCaseSensitive is false, Cognito will not check the capitalization of the alias when signing in. Default is true.

Choice-based authentication: passwordless sign-in / passkey sign-in

User pools can be configured to allow the following authentication methods in choice-based authentication:

  • Passwordless sign-in with email message one-time password
  • Passwordless sign-in with SMS message one-time password
  • Passkey (WebAuthn) sign-in

To use choice-based authentication, User pool feature plan should be Essentials or higher.

For details of authentication methods and client implementation, see Manage authentication methods in AWS SDKs.

The following code configures a user pool with choice-based authentication enabled: 

 UserPool userPool = UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder()
                         .password(true) // password authentication must be enabled
                         .emailOtp(true) // enables email message one-time password
                         .smsOtp(true) // enables SMS message one-time password
                         .passkey(true)
                         .build())
                 .build())
         .build();
 
 // You should also configure the user pool client with USER_AUTH authentication flow allowed
 userPool.addClient("myclient", UserPoolClientOptions.builder()
         .authFlows(AuthFlow.builder().user(true).build())
         .build());

⚠️ Enabling SMS message one-time password requires the AWS account be activated to SMS message sending. Learn more about SMS message settings for Amazon Cognito user pools.

When enabling passkey sign-in, you should specify the authentication domain used as the relying party ID. Learn more about passkey sign-in of user pools and Web Authentication API. 

 // Use the hosted Amazon Cognito domain as the relying party ID
 // Use the hosted Amazon Cognito domain as the relying party ID
 UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder().password(true).passkey(true).build())
                 .build())
         .passkeyRelyingPartyId("myclientname.auth.region-name.amazoncognito.com")
         .build();
 
 // Use the custom domain as the relying party ID
 // Use the custom domain as the relying party ID
 UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder().password(true).passkey(true).build())
                 .build())
         .passkeyRelyingPartyId("auth.example.com")
         .build();

You can configure user verification to be preferred (default) or required. When you set user verification to preferred, users can set up authenticators that don't have the user verification capability, and registration and authentication operations can succeed without user verification. To mandate user verification in passkey registration and authentication, specify passkeyUserVerification to PasskeyUserVerification.REQUIRED. 

 UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder().password(true).passkey(true).build())
                 .build())
         .passkeyRelyingPartyId("auth.example.com")
         .passkeyUserVerification(PasskeyUserVerification.REQUIRED)
         .build();

To disable choice-based authentication explicitly, specify password only. 

 UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder().password(true).build())
                 .build())
         .featurePlan(FeaturePlan.LITE)
         .build();

Attributes

Attributes represent the various properties of each user that's collected and stored in the user pool. Cognito provides a set of standard attributes that are available for all user pools. Users are allowed to select any of these standard attributes to be required. Users will not be able to sign up to the user pool without providing the required attributes. Besides these, additional attributes can be further defined, and are known as custom attributes.

Learn more on attributes in Cognito's documentation.

The following code configures a user pool with two standard attributes (name and address) as required and mutable, and adds four custom attributes. 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .standardAttributes(StandardAttributes.builder()
                 .fullname(StandardAttribute.builder()
                         .required(true)
                         .mutable(false)
                         .build())
                 .address(StandardAttribute.builder()
                         .required(false)
                         .mutable(true)
                         .build())
                 .build())
         .customAttributes(Map.of(
                 "myappid", StringAttribute.Builder.create().minLen(5).maxLen(15).mutable(false).build(),
                 "callingcode", NumberAttribute.Builder.create().min(1).max(3).mutable(true).build(),
                 "isEmployee", BooleanAttribute.Builder.create().mutable(true).build(),
                 "joinedOn", new DateTimeAttribute()))
         .build();

As shown in the code snippet, there are data types that are available for custom attributes. The 'String' and 'Number' data types allow for further constraints on their length and values, respectively.

Custom attributes cannot be marked as required.

All custom attributes share the property mutable that specifies whether the value of the attribute can be changed. The default value is false.

User pools come with two 'built-in' attributes - email_verified and phone_number_verified. These cannot be configured (required-ness or mutability) as part of user pool creation. However, user pool administrators can modify them for specific users using the AdminUpdateUserAttributes API.

Attribute verification

When your user updates an email address or phone number attribute, Amazon Cognito marks it unverified until they verify the new value. You can’t send messages to an unverified email address or phone number. Your user can’t sign in with an unverified alias attribute. You can choose how Amazon Cognito handles an updated email address or phone number after the update and before the verification.

Learn more on configuring email or phone verification in Cognito's documentation.

The following code configures a user pool that keeps the original value for the two standard attributes (email and phone_number) until the new values are verified. 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .signInAliases(SignInAliases.builder().username(true).build())
         .autoVerify(AutoVerifiedAttrs.builder().email(true).phone(true).build())
         .keepOriginal(KeepOriginalAttrs.builder()
                 .email(true)
                 .phone(true)
                 .build())
         .build();

Security

Cognito sends various messages to its users via SMS, for different actions, ranging from account verification to marketing. In order to send SMS messages, Cognito needs an IAM role that it can assume, with permissions that allow it to send SMS messages.

By default, the CDK looks at all of the specified properties (and their defaults when not explicitly specified) and automatically creates an SMS role, when needed. For example, if MFA second factor by SMS is enabled, the CDK will create a new role. The smsRole property can be used to specify the user supplied role that should be used instead. Additionally, the property enableSmsRole can be used to override the CDK's default behaviour to either enable or suppress automatic role creation. 

 Role poolSmsRole = Role.Builder.create(this, "userpoolsmsrole")
         .assumedBy(new ServicePrincipal("foo"))
         .build();
 
 UserPool.Builder.create(this, "myuserpool")
         // ...
         .smsRole(poolSmsRole)
         .smsRoleExternalId("c87467be-4f34-11ea-b77f-2e728ce88125")
         .build();

When the smsRole property is specified, the smsRoleExternalId may also be specified. The value of smsRoleExternalId will be used as the sts:ExternalId when the Cognito service assumes the role. In turn, the role's assume role policy should be configured to accept this value as the ExternalId. Learn more about ExternalId here.

Multi-factor Authentication (MFA)

User pools can be configured to enable multi-factor authentication (MFA). It can either be turned off, set to optional or made required. Setting MFA to optional means that individual users can choose to enable it. Additionally, the MFA code can be sent either via SMS text message or via a time-based software token. See the documentation on MFA to learn more.

The following code snippet marks MFA for the user pool as required. This means that all users are required to configure an MFA token and use it for sign in. It also allows for the users to use both SMS based MFA, as well, time-based one time password (TOTP).

If you want to enable email-based MFA, set email property to the Amazon SES email-sending configuration and set featurePlan to FeaturePlan.ESSENTIALS or FeaturePlan.PLUS. For more information, see SMS and email message MFA. 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .mfa(Mfa.REQUIRED)
         .mfaSecondFactor(MfaSecondFactor.builder()
                 .sms(true)
                 .otp(true)
                 .email(false)
                 .build())
         .build();

User pools can be configured with policies around a user's password. This includes the password length and the character sets that they must contain.

Further to this, it can also be configured with the validity of the auto-generated temporary password. A temporary password is generated by the user pool either when an admin signs up a user or when a password reset is requested. The validity of this password dictates how long to give the user to use this password before expiring it.

You can also set a policy for password reuse by setting the passwordHistorySize property. You can prevent a user from resetting their password to a new password that matches their current password or any of up to 23 additional previous passwords, for a maximum total of 24. The passwordHistorySize property can not be set when featurePlan is FeaturePlan.LITE.

The following code snippet configures these properties - 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .passwordPolicy(PasswordPolicy.builder()
                 .minLength(12)
                 .requireLowercase(true)
                 .requireUppercase(true)
                 .requireDigits(true)
                 .requireSymbols(true)
                 .tempPasswordValidity(Duration.days(3))
                 .build())
         .build();

Note that, tempPasswordValidity can be specified only in whole days. Specifying fractional days would throw an error.

Account Recovery Settings

User pools can be configured on which method a user should use when recovering the password for their account. This can either be email and/or SMS. Read more at Recovering User Accounts 

 UserPool.Builder.create(this, "UserPool")
         // ...
         .accountRecovery(AccountRecovery.EMAIL_ONLY)
         .build();

The default for account recovery is by phone if available and by email otherwise. A user will not be allowed to reset their password via phone if they are also using it for MFA.

Advanced Security Mode

⚠️ Advanced Security Mode is deprecated in favor of Threat Protection.

User pools can be configured to use Advanced security. You can turn the user pool advanced security features on, and customize the actions that are taken in response to different risks. Or you can use audit mode to gather metrics on detected risks without taking action. In audit mode, the advanced security features publish metrics to Amazon CloudWatch. See the documentation on Advanced security to learn more. 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .advancedSecurityMode(AdvancedSecurityMode.ENFORCED)
         .build();

Threat Protection

Threat Protection can be set to configure enforcement levels and automatic responses for users in password-based and custom-challenge authentication flows. For configuration, there are 2 options for standard authentication and custom authentication. These are represented with properties standardThreatProtectionMode and customThreatProtectionMode. See the documentation on Threat Protection

Note: Threat Protection requires the PLUS feature plan for new user pools. CDK allows you to configure threat protection settings at synthesis time, and CloudFormation will validate feature plan requirements at deployment time. Existing user pools that are grandfathered on LITE plans with threat protection enabled will continue to work.

Emails

Cognito sends emails to users in the user pool, when particular actions take place, such as welcome emails, invitation emails, password resets, etc. The address from which these emails are sent can be configured on the user pool. Read more at Email settings for User Pools.

By default, user pools are configured to use Cognito's built in email capability, which will send emails from no-reply@verificationemail.com. If you want to use a custom email address you can configure Cognito to send emails through Amazon SES, which is detailed below. 

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withCognito("support@myawesomeapp.com"))
         .build();

For typical production environments, the default email limit is below the required delivery volume. To enable a higher delivery volume, you can configure the UserPool to send emails through Amazon SES. To do so, follow the steps in the Cognito Developer Guide to verify an email address, move the account out of the SES sandbox, and grant Cognito email permissions via an authorization policy.

Once the SES setup is complete, the UserPool can be configured to use the SES email. 

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("Awesome App")
                 .replyTo("support@myawesomeapp.com")
                 .build()))
         .build();

Sending emails through SES requires that SES be configured (as described above) in a valid SES region. If the UserPool is being created in a different region, sesRegion must be used to specify the correct SES region. 

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .sesRegion("us-east-1")
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("Awesome App")
                 .replyTo("support@myawesomeapp.com")
                 .build()))
         .build();

When sending emails from an SES verified domain, sesVerifiedDomain can be used to specify the domain. The email address does not need to be verified when sending emails from a verified domain, because the identity of the email configuration is can be determined from the domain alone. 

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .sesRegion("us-east-1")
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("Awesome App")
                 .replyTo("support@myawesomeapp.com")
                 .sesVerifiedDomain("myawesomeapp.com")
                 .build()))
         .build();

If fromName does not comply RFC 5322 atom or quoted-string, it will be quoted or mime-encoded. 

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("myname@mycompany.com")
                 .build()))
         .build();

Device Tracking

User pools can be configured to track devices that users have logged in to. Read more at Device Tracking 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .deviceTracking(DeviceTracking.builder()
                 .challengeRequiredOnNewDevice(true)
                 .deviceOnlyRememberedOnUserPrompt(true)
                 .build())
         .build();

The default is to not track devices.

Lambda Triggers

User pools can be configured such that AWS Lambda functions can be triggered when certain user operations or actions occur, such as, sign up, user confirmation, sign in, etc. They can also be used to add custom authentication challenges, user migrations and custom verification messages. Learn more about triggers at User Pool Workflows with Triggers.

Lambda triggers can either be specified as part of the UserPool initialization, or it can be added later, via methods on the construct, as so - 

 Function authChallengeFn = Function.Builder.create(this, "authChallengeFn")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build();
 
 UserPool userpool = UserPool.Builder.create(this, "myuserpool")
         // ...
         .lambdaTriggers(UserPoolTriggers.builder()
                 .createAuthChallenge(authChallengeFn)
                 .build())
         .build();
 
 userpool.addTrigger(UserPoolOperation.USER_MIGRATION, Function.Builder.create(this, "userMigrationFn")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build());

Additionally, only the pre token generation Lambda trigger supports trigger events with lambda version V2.0 or V3.0. For details, see Pre Token Generation Lambda Trigger. 

 UserPool userpool;
 Function preTokenGenerationFn;
 
 
 userpool.addTrigger(UserPoolOperation.PRE_TOKEN_GENERATION_CONFIG, preTokenGenerationFn, LambdaVersion.V2_0);

The following table lists the set of triggers available, and their corresponding method to add it to the user pool. For more information on the function of these triggers and how to configure them, read User Pool Workflows with Triggers.

Trigger Permissions

The function.attachToRolePolicy() API can be used to add additional IAM permissions to the lambda trigger as necessary.

⚠️ Using the attachToRolePolicy API to provide permissions to your user pool will result in a circular dependency. See aws/aws-cdk#7016. Error message when running cdk synth or cdk deploy:

Circular dependency between resources: [pool056F3F7E, fnPostAuthFnCognitoA630A2B1, ...]

To work around the circular dependency issue, use the attachInlinePolicy() API instead, as shown below. 

 Function postAuthFn;
 
 
 UserPool userpool = UserPool.Builder.create(this, "myuserpool")
         .lambdaTriggers(UserPoolTriggers.builder()
                 .postAuthentication(postAuthFn)
                 .build())
         .build();
 
 // provide permissions to describe the user pool scoped to the ARN the user pool
 postAuthFn.role.attachInlinePolicy(Policy.Builder.create(this, "userpool-policy")
         .statements(List.of(PolicyStatement.Builder.create()
                 .actions(List.of("cognito-idp:DescribeUserPool"))
                 .resources(List.of(userpool.getUserPoolArn()))
                 .build()))
         .build());

Importing User Pools

Any user pool that has been created outside of this stack, can be imported into the CDK app. Importing a user pool allows for it to be used in other parts of the CDK app that reference an IUserPool. However, imported user pools have limited configurability. As a rule of thumb, none of the properties that are part of the AWS::Cognito::UserPool CloudFormation resource can be configured.

User pools can be imported either using their id via the UserPool.fromUserPoolId(), or by using their ARN, via the UserPool.fromUserPoolArn() API. 

 IUserPool awesomePool = UserPool.fromUserPoolId(this, "awesome-user-pool", "us-east-1_oiuR12Abd");
 
 IUserPool otherAwesomePool = UserPool.fromUserPoolArn(this, "other-awesome-user-pool", "arn:aws:cognito-idp:eu-west-1:123456789012:userpool/us-east-1_mtRyYQ14D");

Identity Providers

Users that are part of a user pool can sign in either directly through a user pool, or federate through a third-party identity provider. Once configured, the Cognito backend will take care of integrating with the third-party provider. Read more about Adding User Pool Sign-in Through a Third Party.

The following third-party identity providers are currently supported in the CDK -

The following code configures a user pool to federate with the third party provider, 'Login with Amazon'. The identity provider needs to be configured with a set of credentials that the Cognito backend can use to federate with the third-party identity provider. 

 UserPool userpool = new UserPool(this, "Pool");
 
 UserPoolIdentityProviderAmazon provider = UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .userPool(userpool)
         .build();

Using Google identity provider is possible to use clientSecretValue with SecretValue from secrets manager. 

 UserPool userpool = new UserPool(this, "Pool");
 SecretValue secret = Secret.fromSecretAttributes(this, "CognitoClientSecret", SecretAttributes.builder()
         .secretCompleteArn("arn:aws:secretsmanager:xxx:xxx:secret:xxx-xxx")
         .build()).getSecretValue();
 
 UserPoolIdentityProviderGoogle provider = UserPoolIdentityProviderGoogle.Builder.create(this, "Google")
         .clientId("amzn-client-id")
         .clientSecretValue(secret)
         .userPool(userpool)
         .build();

Using SAML identity provider is possible to use SAML metadata file content or SAML metadata file url. 

 UserPool userpool = new UserPool(this, "Pool");
 
 // specify the metadata as a file content
 // specify the metadata as a file content
 UserPoolIdentityProviderSaml.Builder.create(this, "userpoolIdpFile")
         .userPool(userpool)
         .metadata(UserPoolIdentityProviderSamlMetadata.file("my-file-contents"))
         // Whether to require encrypted SAML assertions from IdP
         .encryptedResponses(true)
         // The signing algorithm for the SAML requests
         .requestSigningAlgorithm(SigningAlgorithm.RSA_SHA256)
         // Enable IdP initiated SAML auth flow
         .idpInitiated(true)
         .build();
 
 // specify the metadata as a URL
 // specify the metadata as a URL
 UserPoolIdentityProviderSaml.Builder.create(this, "userpoolidpUrl")
         .userPool(userpool)
         .metadata(UserPoolIdentityProviderSamlMetadata.url("https://my-metadata-url.com"))
         .build();

Attribute mapping allows mapping attributes provided by the third-party identity providers to standard and custom attributes of the user pool. Learn more about Specifying Identity Provider Attribute Mappings for Your User Pool.

The following code shows how different attributes provided by 'Login With Amazon' can be mapped to standard and custom user pool attributes. 

 UserPool userpool = new UserPool(this, "Pool");
 
 UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .userPool(userpool)
         .attributeMapping(AttributeMapping.builder()
                 .email(ProviderAttribute.AMAZON_EMAIL)
                 .website(ProviderAttribute.other("url")) // use other() when an attribute is not pre-defined in the CDK
                 .custom(Map.of(
                         // custom user pool attributes go here
                         "uniqueId", ProviderAttribute.AMAZON_USER_ID))
                 .build())
         .build();

App Clients

An app is an entity within a user pool that has permission to call unauthenticated APIs (APIs that do not have an authenticated user), such as APIs to register, sign in, and handle forgotten passwords. To call these APIs, you need an app client ID and an optional client secret. Read Configuring a User Pool App Client to learn more.

The following code creates an app client and retrieves the client id - 

 UserPool pool = new UserPool(this, "pool");
 UserPoolClient client = pool.addClient("customer-app-client");
 String clientId = client.getUserPoolClientId();

Existing app clients can be imported into the CDK app using the UserPoolClient.fromUserPoolClientId() API. For new and imported user pools, clients can also be created via the UserPoolClient constructor, as so - 

 IUserPool importedPool = UserPool.fromUserPoolId(this, "imported-pool", "us-east-1_oiuR12Abd");
 UserPoolClient.Builder.create(this, "customer-app-client")
         .userPool(importedPool)
         .build();

Clients can be configured with authentication flows. Authentication flows allow users on a client to be authenticated with a user pool. Cognito user pools provide several different types of authentication, such as, SRP (Secure Remote Password) authentication, username-and-password authentication, etc. Learn more about this at UserPool Authentication Flow.

The following code configures a client to use both SRP and username-and-password authentication - 

 UserPool pool = new UserPool(this, "pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         .authFlows(AuthFlow.builder()
                 .userPassword(true)
                 .userSrp(true)
                 .build())
         .build());

Custom authentication protocols can be configured by setting the custom property under authFlow and defining lambda functions for the corresponding user pool triggers. Learn more at Custom Authentication Flow.

Choice-based authentication can be configured by setting the user property under authFlow. This enables the USER_AUTH authentication flow. Learn more at Choice-based authentication.

In addition to these authentication mechanisms, Cognito user pools also support using OAuth 2.0 framework for authenticating users. User pool clients can be configured with OAuth 2.0 authorization flows and scopes. Learn more about the OAuth 2.0 authorization framework and Cognito user pool's implementation of OAuth2.0.

The following code configures an app client with the authorization code grant flow and registers the the app's welcome page as a callback (or redirect) URL. It also configures the access token scope to 'openid'. All of these concepts can be found in the OAuth 2.0 RFC. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .authorizationCodeGrant(true)
                         .build())
                 .scopes(List.of(OAuthScope.OPENID))
                 .callbackUrls(List.of("https://my-app-domain.com/welcome"))
                 .logoutUrls(List.of("https://my-app-domain.com/signin"))
                 .build())
         .build());

To set a default redirect URI, use the defaultRedirectUri property. Its value must be present in the callbackUrls list. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .authorizationCodeGrant(true)
                         .build())
                 .scopes(List.of(OAuthScope.OPENID))
                 .defaultRedirectUri("https://my-app-domain.com/welcome")
                 .callbackUrls(List.of("https://my-app-domain.com/welcome", "https://my-app-domain.com/hello"))
                 .logoutUrls(List.of("https://my-app-domain.com/signin"))
                 .build())
         .build());

An app client can be configured to prevent user existence errors. This instructs the Cognito authentication API to return generic authentication failure responses instead of an UserNotFoundException. By default, the flag is not set, which means the CloudFormation default (false) will be used. See the documentation for the full details on the behavior of this flag. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         .preventUserExistenceErrors(true)
         .build());

All identity providers created in the CDK app are automatically registered into the corresponding user pool. All app clients created in the CDK have all of the identity providers enabled by default. The 'Cognito' identity provider, that allows users to register and sign in directly with the Cognito user pool, is also enabled by default. Alternatively, the list of supported identity providers for a client can be explicitly specified - 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO))
         .build());

If the identity provider and the app client are created in the same stack, specify the dependency between both constructs to make sure that the identity provider already exists when the app client will be created. The app client cannot handle the dependency to the identity provider automatically because the client does not have access to the provider's construct. 

 UserPool pool = new UserPool(this, "Pool");
 UserPoolIdentityProviderAmazon provider = UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .userPool(pool)
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .build();
 
 UserPoolClient client = pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON))
         .build());
 
 client.node.addDependency(provider);

The property authSessionValidity is the session token for each API request in the authentication flow. Valid duration is from 3 to 15 minutes. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .authSessionValidity(Duration.minutes(15))
         .build());

In accordance with the OIDC open standard, Cognito user pool clients provide access tokens, ID tokens and refresh tokens. More information is available at Using Tokens with User Pools. The expiration time for these tokens can be configured as shown below. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .accessTokenValidity(Duration.minutes(60))
         .idTokenValidity(Duration.minutes(60))
         .refreshTokenValidity(Duration.days(30))
         .build());

Clients can (and should) be allowed to read and write relevant user attributes only. Usually every client can be allowed to read the given_name attribute but not every client should be allowed to set the email_verified attribute. The same criteria applies for both standard and custom attributes, more info is available at Attribute Permissions and Scopes. The default behaviour is to allow read and write permissions on all attributes. The following code shows how this can be configured for a client. 

 UserPool pool = new UserPool(this, "Pool");
 
 ClientAttributes clientWriteAttributes = (new ClientAttributes()).withStandardAttributes(StandardAttributesMask.builder().fullname(true).email(true).build()).withCustomAttributes("favoritePizza", "favoriteBeverage");
 
 ClientAttributes clientReadAttributes = clientWriteAttributes.withStandardAttributes(StandardAttributesMask.builder().emailVerified(true).build()).withCustomAttributes("pointsEarned");
 
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .readAttributes(clientReadAttributes)
         .writeAttributes(clientWriteAttributes)
         .build());

Token revocation can be configured to be able to revoke refresh tokens in app clients. By default, token revocation is enabled for new user pools. The property can be used to enable the token revocation in existing app clients or to change the default behavior. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .enableTokenRevocation(true)
         .build());

User Pool clients can generate a client ID as well as a client secret, to support more advanced authentication workflows.

To create a client with an autogenerated client secret, pass the generateSecret: true prop: 

 UserPool importedPool;
 
 
 UserPoolClient userPoolClient = UserPoolClient.Builder.create(this, "UserPoolClient")
         .userPool(importedPool)
         .generateSecret(true)
         .build();
 
 // Allows you to pass the generated secret to other pieces of infrastructure
 SecretValue secret = userPoolClient.getUserPoolClientSecret();

If you set enablePropagateAdditionalUserContextData: true, you can collect and pass information about your user's session to Amazon Cognito advanced security when you use the API to sign them up, sign them in, and reset their password. 

 UserPool importedPool;
 
 
 UserPoolClient userPoolClient = UserPoolClient.Builder.create(this, "UserPoolClient")
         .userPool(importedPool)
         .generateSecret(true)
         .enablePropagateAdditionalUserContextData(true)
         .build();

Refresh token rotation can be configured to enable automatic rotation of refresh tokens. By default, refresh token rotation is disabled. When the refreshTokenRotationGracePeriod is 0, the grace period is disabled and a successful request immediately invalidates the submitted refresh token. 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .refreshTokenRotationGracePeriod(Duration.seconds(40))
         .build());

See Adding user device and session data to API requests for more information.

Resource Servers

A resource server is a server for access-protected resources. It handles authenticated requests from an app that has an access token. See Defining Resource Servers for more information.

An application may choose to model custom permissions via OAuth. Resource Servers provide this capability via custom scopes that are attached to an app client. The following example sets up a resource server for the 'users' resource for two different app clients and configures the clients to use these scopes. 

 UserPool pool = new UserPool(this, "Pool");
 
 ResourceServerScope readOnlyScope = ResourceServerScope.Builder.create().scopeName("read").scopeDescription("Read-only access").build();
 ResourceServerScope fullAccessScope = ResourceServerScope.Builder.create().scopeName("*").scopeDescription("Full access").build();
 
 UserPoolResourceServer userServer = pool.addResourceServer("ResourceServer", UserPoolResourceServerOptions.builder()
         .identifier("users")
         .scopes(List.of(readOnlyScope, fullAccessScope))
         .build());
 
 UserPoolClient readOnlyClient = pool.addClient("read-only-client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 // ...
                 .scopes(List.of(OAuthScope.resourceServer(userServer, readOnlyScope)))
                 .build())
         .build());
 
 UserPoolClient fullAccessClient = pool.addClient("full-access-client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 // ...
                 .scopes(List.of(OAuthScope.resourceServer(userServer, fullAccessScope)))
                 .build())
         .build());

Domains

After setting up an app client, the address for the user pool's sign-up and sign-in webpages can be configured using domains. There are two ways to set up a domain - either the Amazon Cognito hosted domain can be chosen with an available domain prefix, or a custom domain name can be chosen. The custom domain must be one that is already owned, and whose certificate is registered in AWS Certificate Manager.

The following code sets up a user pool domain in Amazon Cognito hosted domain with the prefix 'my-awesome-app', and another domain with the custom domain 'user.myapp.com' - 

 UserPool pool = new UserPool(this, "Pool");
 
 pool.addDomain("CognitoDomain", UserPoolDomainOptions.builder()
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("my-awesome-app")
                 .build())
         .build());
 
 String certificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d";
 
 ICertificate domainCert = Certificate.fromCertificateArn(this, "domainCert", certificateArn);
 pool.addDomain("CustomDomain", UserPoolDomainOptions.builder()
         .customDomain(CustomDomainOptions.builder()
                 .domainName("user.myapp.com")
                 .certificate(domainCert)
                 .build())
         .build());

Read more about Using the Amazon Cognito Domain and Using Your Own Domain.

You can use the managed login page provided by Amazon Cognito to sign in users. The managed login page has two versions: a classic version and a new version. You can switch between the two versions by using the managedLoginVersion property. 

 UserPool pool = new UserPool(this, "Pool");
 
 // Use the new managed login page
 pool.addDomain("CognitoDomainWithBlandingDesignManagedLogin", UserPoolDomainOptions.builder()
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("blanding-design-ui")
                 .build())
         .managedLoginVersion(ManagedLoginVersion.NEWER_MANAGED_LOGIN)
         .build());
 
 // Use the classic hosted UI
 pool.addDomain("DomainWithClassicHostedUi", UserPoolDomainOptions.builder()
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("classic-hosted-ui")
                 .build())
         .managedLoginVersion(ManagedLoginVersion.CLASSIC_HOSTED_UI)
         .build());

The signInUrl() methods returns the fully qualified URL to the login page for the user pool. This page comes from the hosted UI configured with Cognito. Learn more at Hosted UI with the Amazon Cognito Console. 

 UserPool userpool = UserPool.Builder.create(this, "UserPool").build();
 UserPoolClient client = userpool.addClient("Client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .implicitCodeGrant(true)
                         .build())
                 .callbackUrls(List.of("https://myapp.com/home", "https://myapp.com/users"))
                 .build())
         .build());
 UserPoolDomain domain = userpool.addDomain("Domain", UserPoolDomainOptions.builder().build());
 String signInUrl = domain.signInUrl(client, SignInUrlOptions.builder()
         .redirectUri("https://myapp.com/home")
         .build());

Existing domains can be imported into CDK apps using UserPoolDomain.fromDomainName() API 

 IUserPoolDomain myUserPoolDomain = UserPoolDomain.fromDomainName(this, "my-user-pool-domain", "domain-name");

To get the domain name of the CloudFront distribution associated with the user pool domain, use cloudFrontEndpoint method. 

 UserPool userpool = new UserPool(this, "UserPool");
 UserPoolDomain domain = userpool.addDomain("Domain", UserPoolDomainOptions.builder()
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("my-awesome-app")
                 .build())
         .build());
 
 CfnOutput.Builder.create(this, "CloudFrontEndpoint")
         .value(domain.getCloudFrontEndpoint())
         .build();

Deletion protection

Deletion protection can be enabled on a user pool to prevent accidental deletion: 

 UserPool userpool = UserPool.Builder.create(this, "UserPool")
         // ...
         .deletionProtection(true)
         .build();

By default deletion protection is disabled.

email_verified Attribute Mapping

If you use a third-party identity provider, you can specify the email_verified attribute in attributeMapping. 

 UserPool userpool = new UserPool(this, "Pool");
 
 UserPoolIdentityProviderGoogle.Builder.create(this, "google")
         .userPool(userpool)
         .clientId("google-client-id")
         .attributeMapping(AttributeMapping.builder()
                 .email(ProviderAttribute.GOOGLE_EMAIL)
                 .emailVerified(ProviderAttribute.GOOGLE_EMAIL_VERIFIED)
                 .build())
         .build();

User Pool Group

Support for groups in Amazon Cognito user pools enables you to create and manage groups and add users to groups. Use groups to create collections of users to manage their permissions or to represent different types of users.

You can assign an AWS Identity and Access Management (IAM) role to a group to define the permissions for members of a group.

For more information, see Adding groups to a user pool. 

 UserPool userPool;
 Role role;
 
 
 UserPoolGroup.Builder.create(this, "UserPoolGroup")
         .userPool(userPool)
         .groupName("my-group-name")
         .precedence(1)
         .role(role)
         .build();
 
 // You can also add a group by using addGroup method.
 userPool.addGroup("AnotherUserPoolGroup", UserPoolGroupOptions.builder()
         .groupName("another-group-name")
         .build());

Analytics Configuration

User pool clients can be configured with Amazon Pinpoint analytics to collect user activity metrics. This integration enables you to track user engagement and campaign effectiveness.

📝 Note: Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see Amazon Cognito and Amazon Pinpoint Region availability.

The following example shows how to configure analytics for a user pool client:

When specifying a Pinpoint application from the same account

If you specify the application property, do not specify the applicationId, externalId, or roleArn properties. 

 import software.amazon.awscdk.services.pinpoint.*;
 
 UserPool userPool;
 CfnApp pinpointApp;
 Role pinpointRole;
 
 
 UserPoolClient.Builder.create(this, "Client")
         .userPool(userPool)
         .analytics(AnalyticsConfiguration.builder()
                 // Your Pinpoint project
                 .application(pinpointApp)
 
                 // Whether to include user data in analytics events
                 .shareUserData(true)
                 .build())
         .build();

When specifying a Pinpoint application from a different account

If you specify the applicationId, externalId, or roleArn properties, do not specify the application property. (In this case, the applicationId, externalId, and roleArn must all be specified.)

Those three attributes are for the cases when Cognito user pool need to be connected to Pinpoint app in other account. 

 import software.amazon.awscdk.services.pinpoint.*;
 
 UserPool userPool;
 CfnApp pinpointApp;
 Role pinpointRole;
 
 
 UserPoolClient.Builder.create(this, "Client")
         .userPool(userPool)
         .analytics(AnalyticsConfiguration.builder()
                 // Your Pinpoint project ID
                 .applicationId(pinpointApp.getRef())
 
                 // External ID for the IAM role
                 .externalId("sample-external-id")
 
                 // IAM role that Cognito can assume to publish to Pinpoint
                 .role(pinpointRole)
 
                 // Whether to include user data in analytics events
                 .shareUserData(true)
                 .build())
         .build();