Interface CfnUserPoolProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUserPoolProps.Jsii$Proxy
CfnUserPool.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cognito.*;
Object userPoolTags;
CfnUserPoolProps cfnUserPoolProps = CfnUserPoolProps.builder()
.accountRecoverySetting(AccountRecoverySettingProperty.builder()
.recoveryMechanisms(List.of(RecoveryOptionProperty.builder()
.name("name")
.priority(123)
.build()))
.build())
.adminCreateUserConfig(AdminCreateUserConfigProperty.builder()
.allowAdminCreateUserOnly(false)
.inviteMessageTemplate(InviteMessageTemplateProperty.builder()
.emailMessage("emailMessage")
.emailSubject("emailSubject")
.smsMessage("smsMessage")
.build())
.unusedAccountValidityDays(123)
.build())
.aliasAttributes(List.of("aliasAttributes"))
.autoVerifiedAttributes(List.of("autoVerifiedAttributes"))
.deletionProtection("deletionProtection")
.deviceConfiguration(DeviceConfigurationProperty.builder()
.challengeRequiredOnNewDevice(false)
.deviceOnlyRememberedOnUserPrompt(false)
.build())
.emailAuthenticationMessage("emailAuthenticationMessage")
.emailAuthenticationSubject("emailAuthenticationSubject")
.emailConfiguration(EmailConfigurationProperty.builder()
.configurationSet("configurationSet")
.emailSendingAccount("emailSendingAccount")
.from("from")
.replyToEmailAddress("replyToEmailAddress")
.sourceArn("sourceArn")
.build())
.emailVerificationMessage("emailVerificationMessage")
.emailVerificationSubject("emailVerificationSubject")
.enabledMfas(List.of("enabledMfas"))
.lambdaConfig(LambdaConfigProperty.builder()
.createAuthChallenge("createAuthChallenge")
.customEmailSender(CustomEmailSenderProperty.builder()
.lambdaArn("lambdaArn")
.lambdaVersion("lambdaVersion")
.build())
.customMessage("customMessage")
.customSmsSender(CustomSMSSenderProperty.builder()
.lambdaArn("lambdaArn")
.lambdaVersion("lambdaVersion")
.build())
.defineAuthChallenge("defineAuthChallenge")
.kmsKeyId("kmsKeyId")
.postAuthentication("postAuthentication")
.postConfirmation("postConfirmation")
.preAuthentication("preAuthentication")
.preSignUp("preSignUp")
.preTokenGeneration("preTokenGeneration")
.preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder()
.lambdaArn("lambdaArn")
.lambdaVersion("lambdaVersion")
.build())
.userMigration("userMigration")
.verifyAuthChallengeResponse("verifyAuthChallengeResponse")
.build())
.mfaConfiguration("mfaConfiguration")
.policies(PoliciesProperty.builder()
.passwordPolicy(PasswordPolicyProperty.builder()
.minimumLength(123)
.passwordHistorySize(123)
.requireLowercase(false)
.requireNumbers(false)
.requireSymbols(false)
.requireUppercase(false)
.temporaryPasswordValidityDays(123)
.build())
.build())
.schema(List.of(SchemaAttributeProperty.builder()
.attributeDataType("attributeDataType")
.developerOnlyAttribute(false)
.mutable(false)
.name("name")
.numberAttributeConstraints(NumberAttributeConstraintsProperty.builder()
.maxValue("maxValue")
.minValue("minValue")
.build())
.required(false)
.stringAttributeConstraints(StringAttributeConstraintsProperty.builder()
.maxLength("maxLength")
.minLength("minLength")
.build())
.build()))
.smsAuthenticationMessage("smsAuthenticationMessage")
.smsConfiguration(SmsConfigurationProperty.builder()
.externalId("externalId")
.snsCallerArn("snsCallerArn")
.snsRegion("snsRegion")
.build())
.smsVerificationMessage("smsVerificationMessage")
.userAttributeUpdateSettings(UserAttributeUpdateSettingsProperty.builder()
.attributesRequireVerificationBeforeUpdate(List.of("attributesRequireVerificationBeforeUpdate"))
.build())
.usernameAttributes(List.of("usernameAttributes"))
.usernameConfiguration(UsernameConfigurationProperty.builder()
.caseSensitive(false)
.build())
.userPoolAddOns(UserPoolAddOnsProperty.builder()
.advancedSecurityAdditionalFlows(AdvancedSecurityAdditionalFlowsProperty.builder()
.customAuthMode("customAuthMode")
.build())
.advancedSecurityMode("advancedSecurityMode")
.build())
.userPoolName("userPoolName")
.userPoolTags(userPoolTags)
.verificationMessageTemplate(VerificationMessageTemplateProperty.builder()
.defaultEmailOption("defaultEmailOption")
.emailMessage("emailMessage")
.emailMessageByLink("emailMessageByLink")
.emailSubject("emailSubject")
.emailSubjectByLink("emailSubjectByLink")
.smsMessage("smsMessage")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnUserPoolPropsstatic final classAn implementation forCfnUserPoolProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnUserPoolProps.Builderbuilder()default ObjectThe available verified method a user can use to recover their password when they callForgotPassword.default ObjectThe settings for administrator creation of users in a user pool.Attributes supported as an alias for this user pool.The attributes to be auto-verified.default StringWhen active,DeletionProtectionprevents accidental deletion of your user pool.default ObjectThe device-remembering configuration for a user pool.default Stringdefault Stringdefault ObjectThe email configuration of your user pool.default StringThis parameter is no longer used.default StringThis parameter is no longer used.Set enabled MFA options on a specified user pool.default ObjectA collection of user pool Lambda triggers.default StringThe multi-factor authentication (MFA) configuration.default ObjectA list of user pool policies.default ObjectAn array of schema attributes for the new user pool.default StringThe contents of the SMS authentication message.default ObjectThe SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.default StringThis parameter is no longer used.default ObjectThe settings for updates to user attributes.Specifies whether a user can use an email address or phone number as a username when they sign up.default ObjectCase sensitivity on the username input for the selected sign-in option.default ObjectUser pool add-ons.default StringA string used to name the user pool.default ObjectThe tag keys and values to assign to the user pool.default ObjectThe template for the verification message that your user pool delivers to users who set an email address or phone number attribute.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAccountRecoverySetting
The available verified method a user can use to recover their password when they callForgotPassword.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.
- See Also:
-
getAdminCreateUserConfig
The settings for administrator creation of users in a user pool.Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- See Also:
-
getAliasAttributes
Attributes supported as an alias for this user pool.Possible values: phone_number , email , or preferred_username .
- See Also:
-
getAutoVerifiedAttributes
The attributes to be auto-verified.Possible values: email , phone_number .
- See Also:
-
getDeletionProtection
When active,DeletionProtectionprevents accidental deletion of your user pool.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
DeleteUserPoolAPI request, Amazon Cognito returns anInvalidParameterExceptionerror. To delete a protected user pool, send a newDeleteUserPoolrequest after you deactivate deletion protection in anUpdateUserPoolAPI request.- See Also:
-
getDeviceConfiguration
The device-remembering configuration for a 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.- See Also:
-
getEmailAuthenticationMessage
- See Also:
-
getEmailAuthenticationSubject
- See Also:
-
getEmailConfiguration
The email configuration of your user pool.The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
- See Also:
-
getEmailVerificationMessage
This parameter is no longer used.- See Also:
-
getEmailVerificationSubject
This parameter is no longer used.- See Also:
-
getEnabledMfas
Set enabled MFA options on a specified user pool.To disable all MFAs after it has been enabled, set
MfaConfigurationtoOFFand remove EnabledMfas. MFAs can only be all disabled ifMfaConfigurationisOFF. After you enableSMS_MFA, you can only disable it by settingMfaConfigurationtoOFF. 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- See Also:
-
getLambdaConfig
A collection of user pool Lambda triggers.Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
- See Also:
-
getMfaConfiguration
The multi-factor authentication (MFA) configuration. Valid values include:.OFFMFA won't be used for any users.ONMFA is required for all users to sign in.OPTIONALMFA will be required only for individual users who have an MFA factor activated.
- See Also:
-
getPolicies
A list of user pool policies. Contains the policy that sets password-complexity requirements.This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- See Also:
-
getSchema
An array of schema attributes for the new user pool.These attributes can be standard or custom attributes.
- See Also:
-
getSmsAuthenticationMessage
The contents of the SMS authentication message.- See Also:
-
getSmsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.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 .
- See Also:
-
getSmsVerificationMessage
This parameter is no longer used.- See Also:
-
getUserAttributeUpdateSettings
The settings for updates to user attributes.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 .- See Also:
-
getUsernameAttributes
Specifies whether a user can use an email address or phone number as a username when they sign up.- See Also:
-
getUsernameConfiguration
Case sensitivity on the username input for the selected sign-in option.When case sensitivity is set to
False(case insensitive), users can sign in with any combination of capital and lowercase letters. For example,username,USERNAME, orUserName, or for email,email@example.comorEMaiL@eXamplE.Com. For most use cases, set case sensitivity toFalse(case insensitive) 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.This configuration is immutable after you set it. For more information, see UsernameConfigurationType .
- See Also:
-
getUserPoolAddOns
User pool add-ons.Contains settings for activation of advanced security features. To log user security information but take no action, set to
AUDIT. To configure automatic security responses to risky traffic to your user pool, set toENFORCED.For more information, see Adding advanced security to a user pool .
- See Also:
-
getUserPoolName
A string used to name the user pool.- See Also:
-
getUserPoolTags
The tag keys and values to assign to the user pool.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.
- See Also:
-
getVerificationMessageTemplate
The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.Set the email message type that corresponds to your
DefaultEmailOptionselection. ForCONFIRM_WITH_LINK, specify anEmailMessageByLinkand leaveEmailMessageblank. ForCONFIRM_WITH_CODE, specify anEmailMessageand leaveEmailMessageByLinkblank. When you supply both parameters with either choice, Amazon Cognito returns an error.- See Also:
-
builder
- Returns:
- a
CfnUserPoolProps.BuilderofCfnUserPoolProps
-