addClient

addDomain

addGroup

Add a new resource server to this user pool.

addResourceServer

Add a lambda trigger to a user pool operation.

addTrigger

grant

Register an identity provider with this user pool.

registerIdentityProvider

UserPool

How will a user be able to recover their account?

accountRecovery

advancedSecurityMode

Attributes which Cognito will look to verify automatically upon user sign up.

EMAIL and PHONE are the only available options.

autoVerify

Define a set of custom attributes that can be configured for each user in the user pool.

customAttributes

This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.

customSenderKmsKey

The Type of Threat Protection Enabled for Custom Authentication.

This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS

customThreatProtectionMode

Indicates whether the user pool should have deletion protection enabled.

deletionProtection

deviceTracking

email

Setting this would explicitly enable or disable SMS role creation.

When left unspecified, CDK will determine based on other properties if a role is needed or not.

enableSmsRole

The user pool feature plan, or tier.

This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection.

featurePlan

Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes.

EMAIL and PHONE are the only available options.

keepOriginal

Lambda functions to use for supported Cognito triggers.

lambdaTriggers

Configure whether users of this user pool can or are required use MFA to sign in.

The SMS message template sent during MFA verification.

Use '{####}' in the template where Cognito should insert the verification code.

mfaMessage

Configure the MFA types that users can use in this user pool.

Ignored if `mfa` is set to `OFF`.

mfaSecondFactor

The authentication domain that passkey providers must use as a relying party (RP) in their configuration.

Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:
- The user pool is configured for passkey authentication.
- The user pool has a custom domain, whether or not it also has a prefix domain.
- Your application performs authentication with managed login or the classic hosted UI.

passkeyRelyingPartyId

Your user-pool treatment for MFA with a passkey.

You can override other MFA options and require passkey MFA, or you can set it as preferred.
When passkey MFA is preferred, the hosted UI encourages users to register a passkey at sign-in.

passkeyUserVerification

passwordPolicy

Policy to apply when the user pool is removed from the stack.

removalPolicy

Whether self sign-up should be enabled.

To configure self sign-up configuration use the `userVerification` property.

selfSignUpEnabled

Methods in which a user registers or signs in to a user pool.

Allows either username with aliases OR sign in with email, phone, or both.

Read the sections on usernames and aliases to learn more -
https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

To match with 'Option 1' in the above link, with a verified email, this property 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 }`.

signInAliases

Whether sign-in aliases should be evaluated with case sensitivity.

For example, when this option is set to false, users will be able to sign in using either `MyUsername` or `myusername`.

signInCaseSensitive

signInPolicy

The IAM role that Cognito will assume while sending SMS messages.

smsRole

The 'ExternalId' that Cognito service must be using when assuming the `smsRole`, if the role is restricted with an 'sts:ExternalId' conditional.

Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

This property will be ignored if `smsRole` is not specified.

smsRoleExternalId

The region to integrate with SNS to send SMS messages.

This property will do nothing if SMS configuration is not configured.

snsRegion

The set of attributes that are required for every user in the user pool.

Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

standardAttributes

The Type of Threat Protection Enabled for Standard Authentication.

This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS

standardThreatProtectionMode

Configuration around admins signing up users into a user pool.

userInvitation

userPoolName

Configuration around users signing themselves up to the user pool.

Enable or disable self sign-up via the `selfSignUpEnabled` property.

userVerification

UserPoolClient

The UserPool resource this client will have access to.

userPool

Validity of the access token.

Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.

accessTokenValidity

The analytics configuration for this client.

analytics

The set of OAuth authentication flows to enable on the client.

authFlows

Cognito creates a session token for each API request in an authentication flow.

AuthSessionValidity is the duration, in minutes, of that session token.
see defaults in `AuthSessionValidity`. Valid duration is from 3 to 15 minutes.

authSessionValidity

Turns off all OAuth interactions for this client.

disableOAuth

Enable the propagation of additional user context data.

You can only activate enablePropagateAdditionalUserContextData in an app client that has a client secret.

enablePropagateAdditionalUserContextData

enableTokenRevocation

generateSecret

Validity of the ID token.

Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.

idTokenValidity

OAuth settings for this client to interact with the app.

An error is thrown when this is specified and `disableOAuth` is set.

oAuth

Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence.

preventUserExistenceErrors

The set of attributes this client will be able to read.

readAttributes

Enables refresh token rotation when set.

Defines the grace period for the original refresh token (0-60 seconds).

refreshTokenRotationGracePeriod

Validity of the refresh token.

Values between 60 minutes and 10 years are valid.

refreshTokenValidity

The list of identity providers that users should be able to use to sign in using this client.

supportedIdentityProviders

userPoolClientName

The set of attributes this client will be able to write.

writeAttributes

The URL to the hosted UI associated with this domain.

baseUrl

The URL to the sign in page in this domain using a specific UserPoolClient.

signInUrl

UserPoolDomain

The user pool to which this domain should be associated.

Associate a cognito prefix domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

cognitoDomain

Associate a custom domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

customDomain

A version that indicates the state of managed login.

This choice applies to all app clients that host services at the domain.

managedLoginVersion

UserPoolGroup

The user pool to which this group is associated.

A string containing the description of the group.

description

groupName

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.

Zero is the highest precedence value.

Groups with lower Precedence values take precedence over groups with higher or null Precedence values.
If a user belongs to two or more groups, it is the group with the lowest precedence value
whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other.
If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role
claim in tokens for users in each group.
If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

precedence

role

Represents an identity provider that integrates with Login with Amazon.

UserPoolIdentityProviderAmazon

The client id recognized by Login with Amazon APIs.

clientId

The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.

clientSecret

The types of user profile data to obtain for the Amazon profile.

scopes

The user pool to which this construct provides identities.

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

attributeMapping

Represents an identity provider that integrates with Apple.

UserPoolIdentityProviderApple

The keyId (of the same key, which content has to be later supplied as `privateKey`) for Apple APIs to authenticate the client.

keyId

The teamId for Apple APIs to authenticate the client.

teamId

The privateKey content for Apple APIs to authenticate the client.

privateKey

privateKeyValue

The list of apple permissions to obtain for getting access to the apple profile.

Represents an identity provider that integrates with Facebook Login.

UserPoolIdentityProviderFacebook

The client id recognized by Facebook APIs.

The client secret to be accompanied with clientId for Facebook to authenticate the client.

apiVersion

The list of Facebook permissions to obtain for getting access to the Facebook profile.

Represents an identity provider that integrates with Google.

UserPoolIdentityProviderGoogle

The client secret to be accompanied with clientId for Google APIs to authenticate the client.

The client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue.

clientSecretValue

The list of Google permissions to obtain for getting access to the Google profile.

Represents an identity provider that integrates with OpenID Connect.

UserPoolIdentityProviderOidc

issuerUrl

attributeRequestMethod

endpoints

Identifiers.

Identifiers can be used to redirect users to the correct IdP in multitenant apps.

identifiers

name

The OAuth 2.0 scopes that you will request from OpenID Connect. Scopes are groups of OpenID Connect user attributes to exchange with your app.

Represents an identity provider that integrates with SAML.

UserPoolIdentityProviderSaml

metadata

Whether to require encrypted SAML assertions from IdP.

encryptedResponses

Whether to enable IdP-initiated SAML auth flows.

idpInitiated

Whether to enable the "Sign-out flow" feature.

idpSignout

The name of the provider.

Must be between 3 and 32 characters.

requestSigningAlgorithm

Defines a User Pool OAuth2.0 Resource Server.

UserPoolResourceServer

The user pool to add this resource server to.

A unique resource server identifier for the resource server.

identifier

userPoolResourceServerName

The `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito identity pool.

To avoid deleting the resource accidentally from CloudFormation , use [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and the [UpdateReplacePolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) to retain the resource on deletion or replacement.

CfnIdentityPool

Specifies whether the identity pool supports unauthenticated logins.

allowUnauthenticatedIdentities

Enables the Basic (Classic) authentication flow.

allowClassicFlow

cognitoEvents

The Amazon Cognito user pools and their client IDs.

cognitoIdentityProviders

Configuration options for configuring Amazon Cognito streams.

cognitoStreams

The "domain" Amazon Cognito uses when referencing your users.

This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the `DeveloperProviderName` , you can use letters and periods (.), underscores (_), and dashes (-).

*Minimum length* : 1

*Maximum length* : 100

developerProviderName

The name of your Amazon Cognito identity pool.

*Minimum length* : 1

*Maximum length* : 128

*Pattern* : `[\w\s+=,.@-]+`

identityPoolName

Tags to assign to the identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Amazon Cognito

L2 Constructs11

UserPool

UserPoolClient

UserPoolDomain

UserPoolGroup

UserPoolIdentityProviderAmazon

UserPoolIdentityProviderApple

UserPoolIdentityProviderFacebook

UserPoolIdentityProviderGoogle

UserPoolIdentityProviderOidc

UserPoolIdentityProviderSaml

UserPoolResourceServer

L1 Constructs16

CfnIdentityPool

CfnIdentityPoolPrincipalTag

CfnIdentityPoolRoleAttachment

CfnLogDeliveryConfiguration

CfnManagedLoginBranding

CfnTerms

CfnUserPool

CfnUserPoolClient

CfnUserPoolDomain

CfnUserPoolGroup

CfnUserPoolIdentityProvider

CfnUserPoolResourceServer

CfnUserPoolRiskConfigurationAttachment

CfnUserPoolUICustomizationAttachment

CfnUserPoolUser

CfnUserPoolUserToGroupAttachment

Get the Amazon Cognito Cheat Sheet

Quick Facts

Related Links