UserPoolArgs class
The set of arguments for UserPool. The set of arguments for UserPool.
Constructors
-
UserPoolArgs({Input<
UserPoolAccountRecoverySetting?> ? accountRecoverySetting, Input<UserPoolAdminCreateUserConfig?> ? adminCreateUserConfig, Input<List< ? aliasAttributes, Input<String> ?>List< ? autoVerifiedAttributes, Input<String> ?>String?> ? deletionProtection, Input<UserPoolDeviceConfiguration?> ? deviceConfiguration, Input<UserPoolEmailConfiguration?> ? emailConfiguration, Input<UserPoolEmailMfaConfiguration?> ? emailMfaConfiguration, Input<String?> ? emailVerificationMessage, Input<String?> ? emailVerificationSubject, Input<UserPoolLambdaConfig?> ? lambdaConfig, Input<String?> ? mfaConfiguration, Input<String?> ? name, Input<UserPoolPasswordPolicy?> ? passwordPolicy, Input<String?> ? region, Input<List< ? schemas, Input<UserPoolSchema> ?>UserPoolSignInPolicy?> ? signInPolicy, Input<String?> ? smsAuthenticationMessage, Input<UserPoolSmsConfiguration?> ? smsConfiguration, Input<String?> ? smsVerificationMessage, Input<UserPoolSoftwareTokenMfaConfiguration?> ? softwareTokenMfaConfiguration, Input<Map< ? tags, Input<String, String> ?>UserPoolUserAttributeUpdateSettings?> ? userAttributeUpdateSettings, Input<UserPoolUserPoolAddOns?> ? userPoolAddOns, Input<String?> ? userPoolTier, Input<List< ? usernameAttributes, Input<String> ?>UserPoolUsernameConfiguration?> ? usernameConfiguration, Input<UserPoolVerificationMessageTemplate?> ? verificationMessageTemplate, Input<UserPoolWebAuthnConfiguration?> ? webAuthnConfiguration}) -
Creates a new UserPoolArgs.
accountRecoverySettingConfiguration block to define which verified available method a user can use to recover their forgotten password. Detailed below.adminCreateUserConfigConfiguration block for creating a new user profile. Detailed below.aliasAttributesAttributes supported as an alias for this user pool. Valid values:phoneNumber,email, orpreferredUsername. Conflicts withusernameAttributes.autoVerifiedAttributesAttributes to be auto-verified. Valid values:email,phoneNumber.deletionProtectionWhen 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. Valid values areACTIVEandINACTIVE, Default value isINACTIVE.deviceConfigurationConfiguration block for the user pool's device tracking. Detailed below.emailConfigurationConfiguration block for configuring email. Detailed below.emailMfaConfigurationConfiguration block for configuring email Multi-Factor Authentication (MFA); requires at least 2accountRecoverySettingentries; requires anemailConfigurationconfiguration block. Effective only whenmfaConfigurationisONorOPTIONAL. Detailed below.emailVerificationMessageString representing the email verification message. Conflicts withverificationMessageTemplateconfiguration blockemailMessageargument.emailVerificationSubjectString representing the email verification subject. Conflicts withverificationMessageTemplateconfiguration blockemailSubjectargument.lambdaConfigConfiguration block for the AWS Lambda triggers associated with the user pool. Detailed below.mfaConfigurationMulti-Factor Authentication (MFA) configuration for the User Pool. Defaults ofOFF. Valid values areOFF(MFA Tokens are not required),ON(MFA is required for all users to sign in; requires at least one ofemailMfaConfiguration,smsConfigurationorsoftwareTokenMfaConfigurationto be configured), orOPTIONAL(MFA Will be required only for individual users who have MFA Enabled; requires at least one ofemailMfaConfiguration,smsConfigurationorsoftwareTokenMfaConfigurationto be configured).nameName of the user pool.passwordPolicyConfiguration block for information about the user pool password policy. Detailed below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.schemasConfiguration block for the schema attributes of a user pool. Detailed below. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.signInPolicyConfiguration block for information about the user pool sign in policy. Detailed below.smsAuthenticationMessageString representing the SMS authentication message. The Message must contain the{####}placeholder, which will be replaced with the code.smsConfigurationConfiguration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only whenmfaConfigurationis set toONorOPTIONALalong with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see thetaintcommand.smsVerificationMessageString representing the SMS verification message. Conflicts withverificationMessageTemplateconfiguration blocksmsMessageargument.softwareTokenMfaConfigurationConfiguration block for software token Mult-Factor Authentication (MFA) settings. Effective only whenmfaConfigurationisONorOPTIONAL. Detailed below.tagsMap of tags to assign to the User Pool. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.userAttributeUpdateSettingsConfiguration block for user attribute update settings. Detailed below.userPoolAddOnsConfiguration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.userPoolTierThe user pool feature plan, or tier. Valid values:LITE,ESSENTIALS,PLUS.usernameAttributesWhether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts withaliasAttributes.usernameConfigurationConfiguration block for username configuration. Detailed below.verificationMessageTemplateConfiguration block for verification message templates. Detailed below.webAuthnConfigurationConfiguration block for web authn configuration. Detailed below.const -
UserPoolArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accountRecoverySetting
→ Input<
UserPoolAccountRecoverySetting?> ? -
Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
final
-
adminCreateUserConfig
→ Input<
UserPoolAdminCreateUserConfig?> ? -
Configuration block for creating a new user profile. Detailed below.
final
-
aliasAttributes
→ Input<
List< ?String> ?> -
Attributes supported as an alias for this user pool. Valid values:
phoneNumber,email, orpreferredUsername. Conflicts withusernameAttributes.final -
autoVerifiedAttributes
→ Input<
List< ?String> ?> -
Attributes to be auto-verified. Valid values:
email,phoneNumber.final -
deletionProtection
→ Input<
String?> ? -
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. Valid values are
ACTIVEandINACTIVE, Default value isINACTIVE.final -
deviceConfiguration
→ Input<
UserPoolDeviceConfiguration?> ? -
Configuration block for the user pool's device tracking. Detailed below.
final
-
emailConfiguration
→ Input<
UserPoolEmailConfiguration?> ? -
Configuration block for configuring email. Detailed below.
final
-
emailMfaConfiguration
→ Input<
UserPoolEmailMfaConfiguration?> ? -
Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2
accountRecoverySettingentries; requires anemailConfigurationconfiguration block. Effective only whenmfaConfigurationisONorOPTIONAL. Detailed below.final -
emailVerificationMessage
→ Input<
String?> ? -
String representing the email verification message. Conflicts with
verificationMessageTemplateconfiguration blockemailMessageargument.final -
emailVerificationSubject
→ Input<
String?> ? -
String representing the email verification subject. Conflicts with
verificationMessageTemplateconfiguration blockemailSubjectargument.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
lambdaConfig
→ Input<
UserPoolLambdaConfig?> ? -
Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
final
-
mfaConfiguration
→ Input<
String?> ? -
Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of
OFF. Valid values areOFF(MFA Tokens are not required),ON(MFA is required for all users to sign in; requires at least one ofemailMfaConfiguration,smsConfigurationorsoftwareTokenMfaConfigurationto be configured), orOPTIONAL(MFA Will be required only for individual users who have MFA Enabled; requires at least one ofemailMfaConfiguration,smsConfigurationorsoftwareTokenMfaConfigurationto be configured).final -
name
→ Input<
String?> ? -
Name of the user pool.
final
-
passwordPolicy
→ Input<
UserPoolPasswordPolicy?> ? -
Configuration block for information about the user pool password policy. Detailed below.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schemas
→ Input<
List< ?UserPoolSchema> ?> -
Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the standard attribute set only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.
final
-
signInPolicy
→ Input<
UserPoolSignInPolicy?> ? -
Configuration block for information about the user pool sign in policy. Detailed below.
final
-
smsAuthenticationMessage
→ Input<
String?> ? -
String representing the SMS authentication message. The Message must contain the
{####}placeholder, which will be replaced with the code.final -
smsConfiguration
→ Input<
UserPoolSmsConfiguration?> ? -
Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only when
mfaConfigurationis set toONorOPTIONALalong with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see thetaintcommand.final -
smsVerificationMessage
→ Input<
String?> ? -
String representing the SMS verification message. Conflicts with
verificationMessageTemplateconfiguration blocksmsMessageargument.final -
softwareTokenMfaConfiguration
→ Input<
UserPoolSoftwareTokenMfaConfiguration?> ? -
Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when
mfaConfigurationisONorOPTIONAL. Detailed below.final -
Map of tags to assign to the User Pool. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
userAttributeUpdateSettings
→ Input<
UserPoolUserAttributeUpdateSettings?> ? -
Configuration block for user attribute update settings. Detailed below.
final
-
usernameAttributes
→ Input<
List< ?String> ?> -
Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with
aliasAttributes.final -
usernameConfiguration
→ Input<
UserPoolUsernameConfiguration?> ? -
Configuration block for username configuration. Detailed below.
final
-
userPoolAddOns
→ Input<
UserPoolUserPoolAddOns?> ? -
Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
final
-
userPoolTier
→ Input<
String?> ? -
The user pool feature plan, or tier. Valid values:
LITE,ESSENTIALS,PLUS.final -
verificationMessageTemplate
→ Input<
UserPoolVerificationMessageTemplate?> ? -
Configuration block for verification message templates. Detailed below.
final
-
webAuthnConfiguration
→ Input<
UserPoolWebAuthnConfiguration?> ? -
Configuration block for web authn configuration. Detailed below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited