UserPoolArgs class

The set of arguments for UserPool. The set of arguments for UserPool.

Constructors

UserPoolArgs({Input<UserPoolAccountRecoverySetting?>? accountRecoverySetting, Input<UserPoolAdminCreateUserConfig?>? adminCreateUserConfig, Input<List<String>?>? aliasAttributes, Input<List<String>?>? autoVerifiedAttributes, Input<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<UserPoolSchema>?>? schemas, Input<UserPoolSignInPolicy?>? signInPolicy, Input<String?>? smsAuthenticationMessage, Input<UserPoolSmsConfiguration?>? smsConfiguration, Input<String?>? smsVerificationMessage, Input<UserPoolSoftwareTokenMfaConfiguration?>? softwareTokenMfaConfiguration, Input<Map<String, String>?>? tags, Input<UserPoolUserAttributeUpdateSettings?>? userAttributeUpdateSettings, Input<UserPoolUserPoolAddOns?>? userPoolAddOns, Input<String?>? userPoolTier, Input<List<String>?>? usernameAttributes, Input<UserPoolUsernameConfiguration?>? usernameConfiguration, Input<UserPoolVerificationMessageTemplate?>? verificationMessageTemplate, Input<UserPoolWebAuthnConfiguration?>? webAuthnConfiguration})
Creates a new UserPoolArgs. accountRecoverySetting Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below. adminCreateUserConfig Configuration block for creating a new user profile. Detailed below. aliasAttributes Attributes supported as an alias for this user pool. Valid values: phoneNumber, email, or preferredUsername. Conflicts with usernameAttributes. autoVerifiedAttributes Attributes to be auto-verified. Valid values: email, phoneNumber. deletionProtection 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 ACTIVE and INACTIVE, Default value is INACTIVE. deviceConfiguration Configuration block for the user pool's device tracking. Detailed below. emailConfiguration Configuration block for configuring email. Detailed below. emailMfaConfiguration Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 accountRecoverySetting entries; requires an emailConfiguration configuration block. Effective only when mfaConfiguration is ON or OPTIONAL. Detailed below. emailVerificationMessage String representing the email verification message. Conflicts with verificationMessageTemplate configuration block emailMessage argument. emailVerificationSubject String representing the email verification subject. Conflicts with verificationMessageTemplate configuration block emailSubject argument. lambdaConfig Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below. mfaConfiguration Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of OFF. Valid values are OFF (MFA Tokens are not required), ON (MFA is required for all users to sign in; requires at least one of emailMfaConfiguration, smsConfiguration or softwareTokenMfaConfiguration to be configured), or OPTIONAL (MFA Will be required only for individual users who have MFA Enabled; requires at least one of emailMfaConfiguration, smsConfiguration or softwareTokenMfaConfiguration to be configured). name Name of the user pool. passwordPolicy Configuration block for information about the user pool password policy. Detailed below. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. schemas 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. signInPolicy Configuration block for information about the user pool sign in policy. Detailed below. smsAuthenticationMessage String representing the SMS authentication message. The Message must contain the {####} placeholder, which will be replaced with the code. smsConfiguration 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 mfaConfiguration is set to ON or OPTIONAL along 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 the taint command. smsVerificationMessage String representing the SMS verification message. Conflicts with verificationMessageTemplate configuration block smsMessage argument. softwareTokenMfaConfiguration Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when mfaConfiguration is ON or OPTIONAL. Detailed below. tags Map of tags to assign to the User Pool. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. userAttributeUpdateSettings Configuration block for user attribute update settings. Detailed below. userPoolAddOns Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below. userPoolTier The user pool feature plan, or tier. Valid values: LITE, ESSENTIALS, PLUS. usernameAttributes Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with aliasAttributes. usernameConfiguration Configuration block for username configuration. Detailed below. verificationMessageTemplate Configuration block for verification message templates. Detailed below. webAuthnConfiguration Configuration 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, or preferredUsername. Conflicts with usernameAttributes.
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 ACTIVE and INACTIVE, Default value is INACTIVE.
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 accountRecoverySetting entries; requires an emailConfiguration configuration block. Effective only when mfaConfiguration is ON or OPTIONAL. Detailed below.
final
emailVerificationMessage → Input<String?>?
String representing the email verification message. Conflicts with verificationMessageTemplate configuration block emailMessage argument.
final
emailVerificationSubject → Input<String?>?
String representing the email verification subject. Conflicts with verificationMessageTemplate configuration block emailSubject argument.
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 are OFF (MFA Tokens are not required), ON (MFA is required for all users to sign in; requires at least one of emailMfaConfiguration, smsConfiguration or softwareTokenMfaConfiguration to be configured), or OPTIONAL (MFA Will be required only for individual users who have MFA Enabled; requires at least one of emailMfaConfiguration, smsConfiguration or softwareTokenMfaConfiguration to 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 mfaConfiguration is set to ON or OPTIONAL along 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 the taint command.
final
smsVerificationMessage → Input<String?>?
String representing the SMS verification message. Conflicts with verificationMessageTemplate configuration block smsMessage argument.
final
softwareTokenMfaConfiguration → Input<UserPoolSoftwareTokenMfaConfiguration?>?
Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when mfaConfiguration is ON or OPTIONAL. Detailed below.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the User Pool. If configured with a provider defaultTags configuration 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