CfnUserPoolProps Struct
Properties for defining a CfnUserPool.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const userPoolTags: any;
const cfnUserPoolProps: cognito.CfnUserPoolProps = {
accountRecoverySetting: {
recoveryMechanisms: [{
name: 'name',
priority: 123,
}],
},
adminCreateUserConfig: {
allowAdminCreateUserOnly: false,
inviteMessageTemplate: {
emailMessage: 'emailMessage',
emailSubject: 'emailSubject',
smsMessage: 'smsMessage',
},
unusedAccountValidityDays: 123,
},
aliasAttributes: ['aliasAttributes'],
autoVerifiedAttributes: ['autoVerifiedAttributes'],
deletionProtection: 'deletionProtection',
deviceConfiguration: {
challengeRequiredOnNewDevice: false,
deviceOnlyRememberedOnUserPrompt: false,
},
emailAuthenticationMessage: 'emailAuthenticationMessage',
emailAuthenticationSubject: 'emailAuthenticationSubject',
emailConfiguration: {
configurationSet: 'configurationSet',
emailSendingAccount: 'emailSendingAccount',
from: 'from',
replyToEmailAddress: 'replyToEmailAddress',
sourceArn: 'sourceArn',
},
emailVerificationMessage: 'emailVerificationMessage',
emailVerificationSubject: 'emailVerificationSubject',
enabledMfas: ['enabledMfas'],
issuerConfiguration: {
type: 'type',
},
keyConfiguration: {
keyType: 'keyType',
kmsKeyArn: 'kmsKeyArn',
},
lambdaConfig: {
createAuthChallenge: 'createAuthChallenge',
customEmailSender: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
customMessage: 'customMessage',
customSmsSender: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
defineAuthChallenge: 'defineAuthChallenge',
inboundFederation: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
kmsKeyId: 'kmsKeyId',
postAuthentication: 'postAuthentication',
postConfirmation: 'postConfirmation',
preAuthentication: 'preAuthentication',
preSignUp: 'preSignUp',
preTokenGeneration: 'preTokenGeneration',
preTokenGenerationConfig: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
userMigration: 'userMigration',
verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
},
mfaConfiguration: 'mfaConfiguration',
policies: {
passwordPolicy: {
minimumLength: 123,
passwordHistorySize: 123,
requireLowercase: false,
requireNumbers: false,
requireSymbols: false,
requireUppercase: false,
temporaryPasswordValidityDays: 123,
},
signInPolicy: {
allowedFirstAuthFactors: ['allowedFirstAuthFactors'],
},
},
schema: [{
attributeDataType: 'attributeDataType',
developerOnlyAttribute: false,
mutable: false,
name: 'name',
numberAttributeConstraints: {
maxValue: 'maxValue',
minValue: 'minValue',
},
required: false,
stringAttributeConstraints: {
maxLength: 'maxLength',
minLength: 'minLength',
},
}],
smsAuthenticationMessage: 'smsAuthenticationMessage',
smsConfiguration: {
eumsSms: {
callerArn: 'callerArn',
// the properties below are optional
configurationSetName: 'configurationSetName',
externalId: 'externalId',
inEntityId: 'inEntityId',
inTemplateId: 'inTemplateId',
originationIdentity: 'originationIdentity',
region: 'region',
},
externalId: 'externalId',
snsCallerArn: 'snsCallerArn',
snsRegion: 'snsRegion',
},
smsVerificationMessage: 'smsVerificationMessage',
userAttributeUpdateSettings: {
attributesRequireVerificationBeforeUpdate: ['attributesRequireVerificationBeforeUpdate'],
},
usernameAttributes: ['usernameAttributes'],
usernameConfiguration: {
caseSensitive: false,
},
userPoolAddOns: {
advancedSecurityAdditionalFlows: {
customAuthMode: 'customAuthMode',
},
advancedSecurityMode: 'advancedSecurityMode',
},
userPoolName: 'userPoolName',
userPoolTags: userPoolTags,
userPoolTier: 'userPoolTier',
verificationMessageTemplate: {
defaultEmailOption: 'defaultEmailOption',
emailMessage: 'emailMessage',
emailMessageByLink: 'emailMessageByLink',
emailSubject: 'emailSubject',
emailSubjectByLink: 'emailSubjectByLink',
smsMessage: 'smsMessage',
},
webAuthnFactorConfiguration: 'webAuthnFactorConfiguration',
webAuthnRelyingPartyId: 'webAuthnRelyingPartyId',
webAuthnUserVerification: 'webAuthnUserVerification',
};
Properties
accountRecoverySettingIResolvable | CfnUserPool.AccountRecoverySettingPropertyaccount_recovery_settingtyping.Union[IResolvable, AccountRecoverySettingProperty]accountRecoverySettingIResolvableAccountRecoverySettingIResolvableAccountRecoverySettinginterface{}#notes
You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
adminCreateUserConfigIResolvable | CfnUserPool.AdminCreateUserConfigPropertyadmin_create_user_configtyping.Union[IResolvable, AdminCreateUserConfigProperty]adminCreateUserConfigIResolvableAdminCreateUserConfigIResolvableAdminCreateUserConfiginterface{}#Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
aliasAttributesstring[]alias_attributestyping.List[str]aliasAttributesList<String>AliasAttributesstring[]AliasAttributes*[]*string#For more information about alias attributes, see Customizing sign-in attributes .
autoVerifiedAttributesstring[]auto_verified_attributestyping.List[str]autoVerifiedAttributesList<String>AutoVerifiedAttributesstring[]AutoVerifiedAttributes*[]*string#For more information, see Verifying contact information at sign-up .
deletionProtectionstringdeletion_protectionstrdeletionProtectionStringDeletionProtectionstringDeletionProtection*string#notes
Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
deviceConfigurationIResolvable | CfnUserPool.DeviceConfigurationPropertydevice_configurationtyping.Union[IResolvable, DeviceConfigurationProperty]deviceConfigurationIResolvableDeviceConfigurationIResolvableDeviceConfigurationinterface{}#notes
Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool . A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any
DeviceConfigurationfield, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices .
emailAuthenticationMessagestringemail_authentication_messagestremailAuthenticationMessageStringEmailAuthenticationMessagestringEmailAuthenticationMessage*string#emailAuthenticationSubjectstringemail_authentication_subjectstremailAuthenticationSubjectStringEmailAuthenticationSubjectstringEmailAuthenticationSubject*string#emailConfigurationIResolvable | CfnUserPool.EmailConfigurationPropertyemail_configurationtyping.Union[IResolvable, EmailConfigurationProperty]emailConfigurationIResolvableEmailConfigurationIResolvableEmailConfigurationinterface{}#The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
emailVerificationMessagestringemail_verification_messagestremailVerificationMessageStringEmailVerificationMessagestringEmailVerificationMessage*string#emailVerificationSubjectstringemail_verification_subjectstremailVerificationSubjectStringEmailVerificationSubjectstringEmailVerificationSubject*string#enabledMfasstring[]enabled_mfastyping.List[str]enabledMfasList<String>EnabledMfasstring[]EnabledMfas*[]*string#notes
To disable all MFAs after it has been enabled, set MfaConfiguration to OFF and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF . After you enable SMS_MFA , you can only disable it by setting MfaConfiguration to OFF . Can be one of the following values:
SMS_MFA- Enables MFA with SMS for the user pool. To select this option, you must also provide values forSmsConfiguration.SOFTWARE_TOKEN_MFA- Enables software token MFA for the user pool.EMAIL_OTP- Enables MFA with email for the user pool. To select this option, you must provide values forEmailConfigurationand within those, setEmailSendingAccounttoDEVELOPER.
Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA | EMAIL_OTP
issuerConfigurationIResolvable | CfnUserPool.IssuerConfigurationPropertyissuer_configurationtyping.Union[IResolvable, IssuerConfigurationProperty]issuerConfigurationIResolvableIssuerConfigurationIResolvableIssuerConfigurationinterface{}#keyConfigurationIResolvable | CfnUserPool.KeyConfigurationPropertykey_configurationtyping.Union[IResolvable, KeyConfigurationProperty]keyConfigurationIResolvableKeyConfigurationIResolvableKeyConfigurationinterface{}#lambdaConfigIResolvable | CfnUserPool.LambdaConfigPropertylambda_configtyping.Union[IResolvable, LambdaConfigProperty]lambdaConfigIResolvableLambdaConfigIResolvableLambdaConfiginterface{}#Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
mfaConfigurationstringmfa_configurationstrmfaConfigurationStringMfaConfigurationstringMfaConfiguration*string#notes
When ON , all users must set up MFA before they can sign in. When OPTIONAL , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL .
When MfaConfiguration is OPTIONAL , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
policiesIResolvable | CfnUserPool.PoliciesPropertypoliciestyping.Union[IResolvable, PoliciesProperty]policiesIResolvablePoliciesIResolvablePoliciesinterface{}#Contains the policy that sets password-complexity requirements.
schemaIResolvable | IResolvable | CfnUserPool.SchemaAttributeProperty[]schematyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SchemaAttributeProperty]]]schemaIResolvableSchemaIResolvableSchemainterface{}#notes
You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes .
smsAuthenticationMessagestringsms_authentication_messagestrsmsAuthenticationMessageStringSmsAuthenticationMessagestringSmsAuthenticationMessage*string#smsConfigurationIResolvable | CfnUserPool.SmsConfigurationPropertysms_configurationtyping.Union[IResolvable, SmsConfigurationProperty]smsConfigurationIResolvableSmsConfigurationIResolvableSmsConfigurationinterface{}#notes
To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see SMS message settings .
smsVerificationMessagestringsms_verification_messagestrsmsVerificationMessageStringSmsVerificationMessagestringSmsVerificationMessage*string#userAttributeUpdateSettingsIResolvable | CfnUserPool.UserAttributeUpdateSettingsPropertyuser_attribute_update_settingstyping.Union[IResolvable, UserAttributeUpdateSettingsProperty]userAttributeUpdateSettingsIResolvableUserAttributeUpdateSettingsIResolvableUserAttributeUpdateSettingsinterface{}#notes
These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .
usernameAttributesstring[]username_attributestyping.List[str]usernameAttributesList<String>UsernameAttributesstring[]UsernameAttributes*[]*string#usernameConfigurationIResolvable | CfnUserPool.UsernameConfigurationPropertyusername_configurationtyping.Union[IResolvable, UsernameConfigurationProperty]usernameConfigurationIResolvableUsernameConfigurationIResolvableUsernameConfigurationinterface{}#notes
When CaseSensitive is false (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to false as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.
When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.
This configuration is immutable after you set it.
userPoolAddOnsIResolvable | CfnUserPool.UserPoolAddOnsPropertyuser_pool_add_onstyping.Union[IResolvable, UserPoolAddOnsProperty]userPoolAddOnsIResolvableUserPoolAddOnsIResolvableUserPoolAddOnsinterface{}#notes
To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED .
For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .
A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
verificationMessageTemplateIResolvable | CfnUserPool.VerificationMessageTemplatePropertyverification_message_templatetyping.Union[IResolvable, VerificationMessageTemplateProperty]verificationMessageTemplateIResolvableVerificationMessageTemplateIResolvableVerificationMessageTemplateinterface{}#notes
Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
webAuthnFactorConfigurationstringweb_authn_factor_configurationstrwebAuthnFactorConfigurationStringWebAuthnFactorConfigurationstringWebAuthnFactorConfiguration*string#webAuthnRelyingPartyIdstringweb_authn_relying_party_idstrwebAuthnRelyingPartyIdStringWebAuthnRelyingPartyIdstringWebAuthnRelyingPartyId*string#notes
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.
webAuthnUserVerificationstringweb_authn_user_verificationstrwebAuthnUserVerificationStringWebAuthnUserVerificationstringWebAuthnUserVerification*string#