CfnUserPoolProps

All Known Implementing Classes:: CfnUserPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:26.020Z")
public interface CfnUserPoolProps

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")
                 .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	Interface and Description
`static class`	`CfnUserPoolProps.Builder` A builder for `CfnUserPoolProps`
`static class`	`CfnUserPoolProps.Jsii$Proxy` An implementation for `CfnUserPoolProps`

Method Summary

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

- Method Detail
  - getAccountRecoverySetting
```
default java.lang.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.
  - getAdminCreateUserConfig
```
default java.lang.Object getAdminCreateUserConfig()
```
    The configuration for creating a new user profile.
  - getAliasAttributes
```
default java.util.List<java.lang.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.
  - getAutoVerifiedAttributes
```
default java.util.List<java.lang.String> getAutoVerifiedAttributes()
```
    The attributes to be auto-verified.
    Possible values: email , phone_number .
  - getDeletionProtection
```
default java.lang.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.
  - getDeviceConfiguration
```
default java.lang.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.
  - getEmailConfiguration
```
default java.lang.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.
  - getEmailVerificationMessage
```
default java.lang.String getEmailVerificationMessage()
```
    This parameter is no longer used.
    See VerificationMessageTemplateType .
  - getEmailVerificationSubject
```
default java.lang.String getEmailVerificationSubject()
```
    This parameter is no longer used.
    See VerificationMessageTemplateType .
  - getEnabledMfas
```
default java.util.List<java.lang.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
  - getLambdaConfig
```
default java.lang.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 .
  - getMfaConfiguration
```
default java.lang.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.
  - getPolicies
```
default java.lang.Object getPolicies()
```
    The policy associated with a user pool.
  - getSchema
```
default java.lang.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.
  - getSmsAuthenticationMessage
```
default java.lang.String getSmsAuthenticationMessage()
```
    A string representing the SMS authentication message.
  - getSmsConfiguration
```
default java.lang.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 .
  - getSmsVerificationMessage
```
default java.lang.String getSmsVerificationMessage()
```
    This parameter is no longer used.
    See VerificationMessageTemplateType .
  - getUserAttributeUpdateSettings
```
default java.lang.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 .
  - getUsernameAttributes
```
default java.util.List<java.lang.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.
  - getUsernameConfiguration
```
default java.lang.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.
  - getUserPoolAddOns
```
default java.lang.Object getUserPoolAddOns()
```
    Enables advanced security risk detection.
    Set the key AdvancedSecurityMode to the value "AUDIT".
  - getUserPoolName
```
default java.lang.String getUserPoolName()
```
    A string used to name the user pool.
  - getUserPoolTags
```
default java.lang.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.
  - getVerificationMessageTemplate
```
default java.lang.Object getVerificationMessageTemplate()
```
    The template for the verification message that the user sees when the app requests permission to access the user's information.
  - builder
```
static CfnUserPoolProps.Builder builder()
```
    Returns:
    
    a CfnUserPoolProps.Builder of CfnUserPoolProps

Interface CfnUserPoolProps

Nested Class Summary

Method Summary

Method Detail

getAccountRecoverySetting

getAdminCreateUserConfig

getAliasAttributes

getAutoVerifiedAttributes

getDeletionProtection

getDeviceConfiguration

getEmailConfiguration

getEmailVerificationMessage

getEmailVerificationSubject

getEnabledMfas

getLambdaConfig

getMfaConfiguration

getPolicies

getSchema

getSmsAuthenticationMessage

getSmsConfiguration

getSmsVerificationMessage

getUserAttributeUpdateSettings

getUsernameAttributes

getUsernameConfiguration

getUserPoolAddOns

getUserPoolName

getUserPoolTags

getVerificationMessageTemplate

builder