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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserPoolProps
static final class
An implementation forCfnUserPoolProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnUserPoolProps.Builder
builder()
default Object
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.default Object
The 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 String
When active,DeletionProtection
prevents accidental deletion of your user pool.default Object
The device-remembering configuration for a user pool.default String
default String
default Object
The email configuration of your user pool.default String
This parameter is no longer used.default String
This parameter is no longer used.Enables MFA on a specified user pool.default Object
A collection of user pool Lambda triggers.default String
The multi-factor authentication (MFA) configuration.default Object
A list of user pool policies.default Object
The schema attributes for the new user pool.default String
A string representing the SMS authentication message.default Object
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.default String
This parameter is no longer used.default Object
The settings for updates to user attributes.Determines whether email addresses or phone numbers can be specified as user names when a user signs up.default Object
You can choose to set case sensitivity on the username input for the selected sign-in option.default Object
User pool add-ons.default String
A string used to name the user pool.default Object
The tag keys and values to assign to the user pool.default Object
The 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
Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over 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 .This user pool property cannot be updated.
- See Also:
-
getAutoVerifiedAttributes
The attributes to be auto-verified.Possible values: email , phone_number .
- See Also:
-
getDeletionProtection
When active,DeletionProtection
prevents 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
DeleteUserPool
API request, Amazon Cognito returns anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API 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
DeviceConfiguration
field, 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
Enables MFA on a specified user pool.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. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values:
SMS_MFA
- Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided.SOFTWARE_TOKEN_MFA
- Enables software token MFA for the user pool.
Allowed values:
SMS_MFA
|SOFTWARE_TOKEN_MFA
- 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:.OFF
MFA won't be used for any users.ON
MFA is required for all users to sign in.OPTIONAL
MFA 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
The schema attributes for the new user pool. These attributes can be standard or custom attributes.During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
- See Also:
-
getSmsAuthenticationMessage
A string representing 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
Determines whether email addresses or phone numbers can be specified as user names when a user signs up.Possible values:
phone_number
oremail
.This user pool property cannot be updated.
- See Also:
-
getUsernameConfiguration
You can choose to set case sensitivity on the username input for the selected sign-in option.For example, when this is set to
False
, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.- 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
DefaultEmailOption
selection. ForCONFIRM_WITH_LINK
, specify anEmailMessageByLink
and leaveEmailMessage
blank. ForCONFIRM_WITH_CODE
, specify anEmailMessage
and leaveEmailMessageByLink
blank. When you supply both parameters with either choice, Amazon Cognito returns an error.- See Also:
-
builder
- Returns:
- a
CfnUserPoolProps.Builder
ofCfnUserPoolProps
-