Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.673Z")
@Stability(Stable)
public interface CfnUserPoolProps
extends software.amazon.jsii.JsiiSerializable

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 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())
         .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)
                         .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()
                 .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolProps.Builder	A builder for CfnUserPoolProps
static final class	CfnUserPoolProps.Jsii$Proxy	An implementation for CfnUserPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolProps.Builder	builder()
default Object	getAccountRecoverySetting()	Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .
default Object	getAdminCreateUserConfig()	The configuration for creating a new user profile.
default List<String>	getAliasAttributes()	Attributes supported as an alias for this user pool.
default List<String>	getAutoVerifiedAttributes()	The attributes to be auto-verified.
default String	getDeletionProtection()	When active, DeletionProtection prevents accidental deletion of your user pool.
default Object	getDeviceConfiguration()	The device-remembering configuration for a user pool.
default Object	getEmailConfiguration()	The email configuration of your user pool.
default String	getEmailVerificationMessage()	This parameter is no longer used.
default String	getEmailVerificationSubject()	This parameter is no longer used.
default List<String>	getEnabledMfas()	Enables MFA on a specified user pool.
default Object	getLambdaConfig()	The Lambda trigger configuration information for the new user pool.
default String	getMfaConfiguration()	The multi-factor authentication (MFA) configuration.
default Object	getPolicies()	The policy associated with a user pool.
default Object	getSchema()	The schema attributes for the new user pool.
default String	getSmsAuthenticationMessage()	A string representing the SMS authentication message.
default Object	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.
default String	getSmsVerificationMessage()	This parameter is no longer used.
default Object	getUserAttributeUpdateSettings()	The settings for updates to user attributes.
default List<String>	getUsernameAttributes()	Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
default Object	getUsernameConfiguration()	You can choose to set case sensitivity on the username input for the selected sign-in option.
default Object	getUserPoolAddOns()	User pool add-ons.
default String	getUserPoolName()	A string used to name the user pool.
default Object	getUserPoolTags()	The tag keys and values to assign to the user pool.
default Object	getVerificationMessageTemplate()	The template for the verification message that the user sees when the app requests permission to access the user's information.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountRecoverySetting

@Stability(Stable)
@Nullable
default Object getAccountRecoverySetting()

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

getAdminCreateUserConfig

@Stability(Stable)
@Nullable
default Object getAdminCreateUserConfig()

The configuration for creating a new user profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

getAliasAttributes

@Stability(Stable)
@Nullable
default List<String> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

getAutoVerifiedAttributes

@Stability(Stable)
@Nullable
default List<String> getAutoVerifiedAttributes()

The attributes to be auto-verified.

Possible values: email , phone_number .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

getDeletionProtection

@Stability(Stable)
@Nullable
default String 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 an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection

getDeviceConfiguration

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

getEmailConfiguration

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

getEmailVerificationMessage

@Stability(Stable)
@Nullable
default String getEmailVerificationMessage()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

getEmailVerificationSubject

@Stability(Stable)
@Nullable
default String getEmailVerificationSubject()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

getEnabledMfas

@Stability(Stable)
@Nullable
default List<String> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

getLambdaConfig

@Stability(Stable)
@Nullable
default Object getLambdaConfig()

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI , see add-permission .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

getMfaConfiguration

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

getPolicies

@Stability(Stable)
@Nullable
default Object getPolicies()

The policy associated with a user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

getSchema

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

getSmsAuthenticationMessage

@Stability(Stable)
@Nullable
default String getSmsAuthenticationMessage()

A string representing the SMS authentication message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

getSmsConfiguration

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

getSmsVerificationMessage

@Stability(Stable)
@Nullable
default String getSmsVerificationMessage()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

getUserAttributeUpdateSettings

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

getUsernameAttributes

@Stability(Stable)
@Nullable
default List<String> getUsernameAttributes()

Determines whether email addresses or phone numbers can be specified as user names when a user signs up.

Possible values: phone_number or email .

This user pool property cannot be updated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

getUsernameConfiguration

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

getUserPoolAddOns

@Stability(Stable)
@Nullable
default Object 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 to ENFORCED .

For more information, see Adding advanced security to a user pool .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

getUserPoolName

@Stability(Stable)
@Nullable
default String getUserPoolName()

A string used to name the user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

getUserPoolTags

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

getVerificationMessageTemplate

@Stability(Stable)
@Nullable
default Object getVerificationMessageTemplate()

The template for the verification message that the user sees when the app requests permission to access the user's information.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

builder

@Stability(Stable)
static CfnUserPoolProps.Builder builder()

Returns:

a CfnUserPoolProps.Builder of CfnUserPoolProps