CfnUserPool (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.cognito.CfnUserPool

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.608Z")
 @Stability(value=Stable)
public class CfnUserPool
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPool`.

The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools and CreateUserPool .

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

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;
 CfnUserPool cfnUserPool = CfnUserPool.Builder.create(this, "MyCfnUserPool")
         .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"))
         .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")
                 .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnUserPool.AccountRecoverySettingProperty` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword` .
`static interface`	`CfnUserPool.AdminCreateUserConfigProperty` The configuration for `AdminCreateUser` requests.
`static class`	`CfnUserPool.Builder` A fluent builder for `CfnUserPool`.
`static interface`	`CfnUserPool.CustomEmailSenderProperty` A custom email sender AWS Lambda trigger.
`static interface`	`CfnUserPool.CustomSMSSenderProperty` A custom SMS sender AWS Lambda trigger.
`static interface`	`CfnUserPool.DeviceConfigurationProperty` The device tracking configuration for a user pool.
`static interface`	`CfnUserPool.EmailConfigurationProperty` The email configuration of your user pool.
`static interface`	`CfnUserPool.InviteMessageTemplateProperty` The message template to be used for the welcome message to new users.
`static interface`	`CfnUserPool.LambdaConfigProperty` Specifies the configuration for AWS Lambda triggers.
`static interface`	`CfnUserPool.NumberAttributeConstraintsProperty` The minimum and maximum values of an attribute that is of the number data type.
`static interface`	`CfnUserPool.PasswordPolicyProperty` The password policy type.
`static interface`	`CfnUserPool.PoliciesProperty` The policy associated with a user pool.
`static interface`	`CfnUserPool.RecoveryOptionProperty` A map containing a priority as a key, and recovery method name as a value.
`static interface`	`CfnUserPool.SchemaAttributeProperty` Contains information about the schema attribute.
`static interface`	`CfnUserPool.SmsConfigurationProperty` The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account .
`static interface`	`CfnUserPool.StringAttributeConstraintsProperty` The `StringAttributeConstraints` property type defines the string attribute constraints of an Amazon Cognito user pool.
`static interface`	`CfnUserPool.UserAttributeUpdateSettingsProperty` The settings for updates to user attributes.
`static interface`	`CfnUserPool.UsernameConfigurationProperty` The `UsernameConfiguration` property type specifies case sensitivity on the username input for the selected sign-in option.
`static interface`	`CfnUserPool.UserPoolAddOnsProperty` The user pool add-ons type.
`static interface`	`CfnUserPool.VerificationMessageTemplateProperty` The template for verification messages.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnUserPool(software.constructs.Construct scope, String id)` Create a new `AWS::Cognito::UserPool`.
	`CfnUserPool(software.constructs.Construct scope, String id, CfnUserPoolProps props)` Create a new `AWS::Cognito::UserPool`.
`protected`	`CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAccountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword` .
`Object`	`getAdminCreateUserConfig()` The configuration for creating a new user profile.
`List<String>`	`getAliasAttributes()` Attributes supported as an alias for this user pool.
`String`	`getAttrArn()` The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341` .
`String`	`getAttrProviderName()` The provider name of the Amazon Cognito user pool, specified as a `String` .
`String`	`getAttrProviderUrl()` The URL of the provider of the Amazon Cognito user pool, specified as a `String` .
`List<String>`	`getAutoVerifiedAttributes()` The attributes to be auto-verified.
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getDeviceConfiguration()` The device configuration.
`Object`	`getEmailConfiguration()` The email configuration of your user pool.
`String`	`getEmailVerificationMessage()` A string representing the email verification message.
`String`	`getEmailVerificationSubject()` A string representing the email verification subject.
`List<String>`	`getEnabledMfas()` Enables MFA on a specified user pool.
`Object`	`getLambdaConfig()` The Lambda trigger configuration information for the new user pool.
`String`	`getMfaConfiguration()` The multi-factor (MFA) configuration.
`Object`	`getPolicies()` The policy associated with a user pool.
`Object`	`getSchema()` The schema attributes for the new user pool.
`String`	`getSmsAuthenticationMessage()` A string representing the SMS authentication message.
`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.
`String`	`getSmsVerificationMessage()` A string representing the SMS verification message.
`TagManager`	`getTags()` The tag keys and values to assign to the user pool.
`Object`	`getUserAttributeUpdateSettings()` The settings for updates to user attributes.
`List<String>`	`getUsernameAttributes()` Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
`Object`	`getUsernameConfiguration()` You can choose to set case sensitivity on the username input for the selected sign-in option.
`Object`	`getUserPoolAddOns()` Enables advanced security risk detection.
`String`	`getUserPoolName()` A string used to name the user pool.
`Object`	`getVerificationMessageTemplate()` The template for the verification message that the user sees when the app requests permission to access the user's information.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAccountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty value)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword` .
`void`	`setAccountRecoverySetting(IResolvable value)` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword` .
`void`	`setAdminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty value)` The configuration for creating a new user profile.
`void`	`setAdminCreateUserConfig(IResolvable value)` The configuration for creating a new user profile.
`void`	`setAliasAttributes(List<String> value)` Attributes supported as an alias for this user pool.
`void`	`setAutoVerifiedAttributes(List<String> value)` The attributes to be auto-verified.
`void`	`setDeviceConfiguration(CfnUserPool.DeviceConfigurationProperty value)` The device configuration.
`void`	`setDeviceConfiguration(IResolvable value)` The device configuration.
`void`	`setEmailConfiguration(CfnUserPool.EmailConfigurationProperty value)` The email configuration of your user pool.
`void`	`setEmailConfiguration(IResolvable value)` The email configuration of your user pool.
`void`	`setEmailVerificationMessage(String value)` A string representing the email verification message.
`void`	`setEmailVerificationSubject(String value)` A string representing the email verification subject.
`void`	`setEnabledMfas(List<String> value)` Enables MFA on a specified user pool.
`void`	`setLambdaConfig(CfnUserPool.LambdaConfigProperty value)` The Lambda trigger configuration information for the new user pool.
`void`	`setLambdaConfig(IResolvable value)` The Lambda trigger configuration information for the new user pool.
`void`	`setMfaConfiguration(String value)` The multi-factor (MFA) configuration.
`void`	`setPolicies(CfnUserPool.PoliciesProperty value)` The policy associated with a user pool.
`void`	`setPolicies(IResolvable value)` The policy associated with a user pool.
`void`	`setSchema(IResolvable value)` The schema attributes for the new user pool.
`void`	`setSchema(List<Object> value)` The schema attributes for the new user pool.
`void`	`setSmsAuthenticationMessage(String value)` A string representing the SMS authentication message.
`void`	`setSmsConfiguration(CfnUserPool.SmsConfigurationProperty value)` 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.
`void`	`setSmsConfiguration(IResolvable value)` 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.
`void`	`setSmsVerificationMessage(String value)` A string representing the SMS verification message.
`void`	`setUserAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty value)` The settings for updates to user attributes.
`void`	`setUserAttributeUpdateSettings(IResolvable value)` The settings for updates to user attributes.
`void`	`setUsernameAttributes(List<String> value)` Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
`void`	`setUsernameConfiguration(CfnUserPool.UsernameConfigurationProperty value)` You can choose to set case sensitivity on the username input for the selected sign-in option.
`void`	`setUsernameConfiguration(IResolvable value)` You can choose to set case sensitivity on the username input for the selected sign-in option.
`void`	`setUserPoolAddOns(CfnUserPool.UserPoolAddOnsProperty value)` Enables advanced security risk detection.
`void`	`setUserPoolAddOns(IResolvable value)` Enables advanced security risk detection.
`void`	`setUserPoolName(String value)` A string used to name the user pool.
`void`	`setVerificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty value)` The template for the verification message that the user sees when the app requests permission to access the user's information.
`void`	`setVerificationMessageTemplate(IResolvable value)` The template for the verification message that the user sees when the app requests permission to access the user's information.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnUserPool
```
protected CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnUserPool
```
protected CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnUserPool
```
@Stability(value=Stable)
public CfnUserPool(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            CfnUserPoolProps props)
```
    Create a new `AWS::Cognito::UserPool`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnUserPool
```
@Stability(value=Stable)
public CfnUserPool(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)
```
    Create a new `AWS::Cognito::UserPool`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341` .
  - getAttrProviderName
```
@Stability(value=Stable)
 @NotNull
public String getAttrProviderName()
```
    The provider name of the Amazon Cognito user pool, specified as a `String` .
  - getAttrProviderUrl
```
@Stability(value=Stable)
 @NotNull
public String getAttrProviderUrl()
```
    The URL of the provider of the Amazon Cognito user pool, specified as a `String` .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    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.
  - getAccountRecoverySetting
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setAccountRecoverySetting
```
@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
                                                               CfnUserPool.AccountRecoverySettingProperty value)
```
    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.
  - setAccountRecoverySetting
```
@Stability(value=Stable)
public void setAccountRecoverySetting(@Nullable
                                                               IResolvable value)
```
    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.
  - getAdminCreateUserConfig
```
@Stability(value=Stable)
 @Nullable
public Object getAdminCreateUserConfig()
```
    The configuration for creating a new user profile.
  - setAdminCreateUserConfig
```
@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
                                                              CfnUserPool.AdminCreateUserConfigProperty value)
```
    The configuration for creating a new user profile.
  - setAdminCreateUserConfig
```
@Stability(value=Stable)
public void setAdminCreateUserConfig(@Nullable
                                                              IResolvable value)
```
    The configuration for creating a new user profile.
  - getAliasAttributes
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setAliasAttributes
```
@Stability(value=Stable)
public void setAliasAttributes(@Nullable
                                                        List<String> value)
```
    Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* .
    
    This user pool property cannot be updated.
  - getAutoVerifiedAttributes
```
@Stability(value=Stable)
 @Nullable
public List<String> getAutoVerifiedAttributes()
```
    The attributes to be auto-verified.
    Possible values: email , phone_number .
  - setAutoVerifiedAttributes
```
@Stability(value=Stable)
public void setAutoVerifiedAttributes(@Nullable
                                                               List<String> value)
```
    The attributes to be auto-verified.
    Possible values: email , phone_number .
  - getDeviceConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getDeviceConfiguration()
```
    The device configuration.
  - setDeviceConfiguration
```
@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
                                                            CfnUserPool.DeviceConfigurationProperty value)
```
    The device configuration.
  - setDeviceConfiguration
```
@Stability(value=Stable)
public void setDeviceConfiguration(@Nullable
                                                            IResolvable value)
```
    The device configuration.
  - getEmailConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setEmailConfiguration
```
@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
                                                           CfnUserPool.EmailConfigurationProperty value)
```
    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.
  - setEmailConfiguration
```
@Stability(value=Stable)
public void setEmailConfiguration(@Nullable
                                                           IResolvable value)
```
    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.
  - getEmailVerificationMessage
```
@Stability(value=Stable)
 @Nullable
public String getEmailVerificationMessage()
```
    A string representing the email verification message.
    EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
  - setEmailVerificationMessage
```
@Stability(value=Stable)
public void setEmailVerificationMessage(@Nullable
                                                                 String value)
```
    A string representing the email verification message.
    EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
  - getEmailVerificationSubject
```
@Stability(value=Stable)
 @Nullable
public String getEmailVerificationSubject()
```
    A string representing the email verification subject.
    EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
  - setEmailVerificationSubject
```
@Stability(value=Stable)
public void setEmailVerificationSubject(@Nullable
                                                                 String value)
```
    A string representing the email verification subject.
    EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
  - getEnabledMfas
```
@Stability(value=Stable)
 @Nullable
public 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
  - setEnabledMfas
```
@Stability(value=Stable)
public void setEnabledMfas(@Nullable
                                                    List<String> value)
```
    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
  - getLambdaConfig
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setLambdaConfig
```
@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     CfnUserPool.LambdaConfigProperty value)
```
    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 .
  - setLambdaConfig
```
@Stability(value=Stable)
public void setLambdaConfig(@Nullable
                                                     IResolvable value)
```
    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 .
  - getMfaConfiguration
```
@Stability(value=Stable)
 @Nullable
public String getMfaConfiguration()
```
    The multi-factor (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.
  - setMfaConfiguration
```
@Stability(value=Stable)
public void setMfaConfiguration(@Nullable
                                                         String value)
```
    The multi-factor (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.
  - getPolicies
```
@Stability(value=Stable)
 @Nullable
public Object getPolicies()
```
    The policy associated with a user pool.
  - setPolicies
```
@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 CfnUserPool.PoliciesProperty value)
```
    The policy associated with a user pool.
  - setPolicies
```
@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 IResolvable value)
```
    The policy associated with a user pool.
  - getSchema
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setSchema
```
@Stability(value=Stable)
public void setSchema(@Nullable
                                               IResolvable value)
```
    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.
  - setSchema
```
@Stability(value=Stable)
public void setSchema(@Nullable
                                               List<Object> value)
```
    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.
  - getSmsAuthenticationMessage
```
@Stability(value=Stable)
 @Nullable
public String getSmsAuthenticationMessage()
```
    A string representing the SMS authentication message.
  - setSmsAuthenticationMessage
```
@Stability(value=Stable)
public void setSmsAuthenticationMessage(@Nullable
                                                                 String value)
```
    A string representing the SMS authentication message.
  - getSmsConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setSmsConfiguration
```
@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
                                                         CfnUserPool.SmsConfigurationProperty value)
```
    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 .
  - setSmsConfiguration
```
@Stability(value=Stable)
public void setSmsConfiguration(@Nullable
                                                         IResolvable value)
```
    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 .
  - getSmsVerificationMessage
```
@Stability(value=Stable)
 @Nullable
public String getSmsVerificationMessage()
```
    A string representing the SMS verification message.
  - setSmsVerificationMessage
```
@Stability(value=Stable)
public void setSmsVerificationMessage(@Nullable
                                                               String value)
```
    A string representing the SMS verification message.
  - getUserAttributeUpdateSettings
```
@Stability(value=Stable)
 @Nullable
public 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 to email addresses and phone numbers .
  - setUserAttributeUpdateSettings
```
@Stability(value=Stable)
public void setUserAttributeUpdateSettings(@Nullable
                                                                    CfnUserPool.UserAttributeUpdateSettingsProperty value)
```
    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 to email addresses and phone numbers .
  - setUserAttributeUpdateSettings
```
@Stability(value=Stable)
public void setUserAttributeUpdateSettings(@Nullable
                                                                    IResolvable value)
```
    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 to email addresses and phone numbers .
  - getUsernameAttributes
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setUsernameAttributes
```
@Stability(value=Stable)
public void setUsernameAttributes(@Nullable
                                                           List<String> value)
```
    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.
  - getUsernameConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setUsernameConfiguration
```
@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
                                                              CfnUserPool.UsernameConfigurationProperty value)
```
    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.
  - setUsernameConfiguration
```
@Stability(value=Stable)
public void setUsernameConfiguration(@Nullable
                                                              IResolvable value)
```
    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.
  - getUserPoolAddOns
```
@Stability(value=Stable)
 @Nullable
public Object getUserPoolAddOns()
```
    Enables advanced security risk detection.
    Set the key AdvancedSecurityMode to the value "AUDIT".
  - setUserPoolAddOns
```
@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
                                                       CfnUserPool.UserPoolAddOnsProperty value)
```
    Enables advanced security risk detection.
    Set the key AdvancedSecurityMode to the value "AUDIT".
  - setUserPoolAddOns
```
@Stability(value=Stable)
public void setUserPoolAddOns(@Nullable
                                                       IResolvable value)
```
    Enables advanced security risk detection.
    Set the key AdvancedSecurityMode to the value "AUDIT".
  - getUserPoolName
```
@Stability(value=Stable)
 @Nullable
public String getUserPoolName()
```
    A string used to name the user pool.
  - setUserPoolName
```
@Stability(value=Stable)
public void setUserPoolName(@Nullable
                                                     String value)
```
    A string used to name the user pool.
  - getVerificationMessageTemplate
```
@Stability(value=Stable)
 @Nullable
public Object getVerificationMessageTemplate()
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
  - setVerificationMessageTemplate
```
@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
                                                                    CfnUserPool.VerificationMessageTemplateProperty value)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
  - setVerificationMessageTemplate
```
@Stability(value=Stable)
public void setVerificationMessageTemplate(@Nullable
                                                                    IResolvable value)
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.

Class CfnUserPool

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnUserPool

CfnUserPool

CfnUserPool

CfnUserPool

Method Detail

inspect

renderProperties

getAttrArn

getAttrProviderName

getAttrProviderUrl

getCfnProperties

getTags

getAccountRecoverySetting

setAccountRecoverySetting

setAccountRecoverySetting

getAdminCreateUserConfig

setAdminCreateUserConfig

setAdminCreateUserConfig

getAliasAttributes

setAliasAttributes

getAutoVerifiedAttributes

setAutoVerifiedAttributes

getDeviceConfiguration

setDeviceConfiguration

setDeviceConfiguration

getEmailConfiguration

setEmailConfiguration

setEmailConfiguration

getEmailVerificationMessage

setEmailVerificationMessage

getEmailVerificationSubject

setEmailVerificationSubject

getEnabledMfas

setEnabledMfas

getLambdaConfig

setLambdaConfig

setLambdaConfig

getMfaConfiguration

setMfaConfiguration

getPolicies

setPolicies

setPolicies

getSchema

setSchema

setSchema

getSmsAuthenticationMessage

setSmsAuthenticationMessage

getSmsConfiguration

setSmsConfiguration

setSmsConfiguration

getSmsVerificationMessage

setSmsVerificationMessage

getUserAttributeUpdateSettings

setUserAttributeUpdateSettings

setUserAttributeUpdateSettings

getUsernameAttributes

setUsernameAttributes

getUsernameConfiguration

setUsernameConfiguration

setUsernameConfiguration

getUserPoolAddOns

setUserPoolAddOns