UserPoolState constructor

const UserPoolState({
  1. Input<UserPoolAccountRecoverySetting?>? accountRecoverySetting,
  2. Input<UserPoolAdminCreateUserConfig?>? adminCreateUserConfig,
  3. Input<List<String>?>? aliasAttributes,
  4. Input<String?>? arn,
  5. Input<List<String>?>? autoVerifiedAttributes,
  6. Input<String?>? creationDate,
  7. Input<String?>? customDomain,
  8. Input<String?>? deletionProtection,
  9. Input<UserPoolDeviceConfiguration?>? deviceConfiguration,
  10. Input<String?>? domain,
  11. Input<UserPoolEmailConfiguration?>? emailConfiguration,
  12. Input<UserPoolEmailMfaConfiguration?>? emailMfaConfiguration,
  13. Input<String?>? emailVerificationMessage,
  14. Input<String?>? emailVerificationSubject,
  15. Input<String?>? endpoint,
  16. Input<int?>? estimatedNumberOfUsers,
  17. Input<UserPoolLambdaConfig?>? lambdaConfig,
  18. Input<String?>? lastModifiedDate,
  19. Input<String?>? mfaConfiguration,
  20. Input<String?>? name,
  21. Input<UserPoolPasswordPolicy?>? passwordPolicy,
  22. Input<String?>? region,
  23. Input<List<UserPoolSchema>?>? schemas,
  24. Input<UserPoolSignInPolicy?>? signInPolicy,
  25. Input<String?>? smsAuthenticationMessage,
  26. Input<UserPoolSmsConfiguration?>? smsConfiguration,
  27. Input<String?>? smsVerificationMessage,
  28. Input<UserPoolSoftwareTokenMfaConfiguration?>? softwareTokenMfaConfiguration,
  29. Input<Map<String, String>?>? tags,
  30. Input<Map<String, String>?>? tagsAll,
  31. Input<UserPoolUserAttributeUpdateSettings?>? userAttributeUpdateSettings,
  32. Input<UserPoolUserPoolAddOns?>? userPoolAddOns,
  33. Input<String?>? userPoolTier,
  34. Input<List<String>?>? usernameAttributes,
  35. Input<UserPoolUsernameConfiguration?>? usernameConfiguration,
  36. Input<UserPoolVerificationMessageTemplate?>? verificationMessageTemplate,
  37. Input<UserPoolWebAuthnConfiguration?>? webAuthnConfiguration,
})

Creates a new UserPoolState. 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. arn ARN of the user pool. autoVerifiedAttributes Attributes to be auto-verified. Valid values: email, phoneNumber. creationDate Date the user pool was created. customDomain A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com. 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. domain Holds the domain prefix if the user pool has a domain associated with it. 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. endpoint Endpoint name of the user pool. Example format: cognito-idp.REGION.amazonaws.com/xxxx_yyyyy estimatedNumberOfUsers A number estimating the size of the user pool. lambdaConfig Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below. lastModifiedDate Date the user pool was last modified. 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. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. 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.

Implementation

const UserPoolState({
  this.accountRecoverySetting,
  this.adminCreateUserConfig,
  this.aliasAttributes,
  this.arn,
  this.autoVerifiedAttributes,
  this.creationDate,
  this.customDomain,
  this.deletionProtection,
  this.deviceConfiguration,
  this.domain,
  this.emailConfiguration,
  this.emailMfaConfiguration,
  this.emailVerificationMessage,
  this.emailVerificationSubject,
  this.endpoint,
  this.estimatedNumberOfUsers,
  this.lambdaConfig,
  this.lastModifiedDate,
  this.mfaConfiguration,
  this.name,
  this.passwordPolicy,
  this.region,
  this.schemas,
  this.signInPolicy,
  this.smsAuthenticationMessage,
  this.smsConfiguration,
  this.smsVerificationMessage,
  this.softwareTokenMfaConfiguration,
  this.tags,
  this.tagsAll,
  this.userAttributeUpdateSettings,
  this.userPoolAddOns,
  this.userPoolTier,
  this.usernameAttributes,
  this.usernameConfiguration,
  this.verificationMessageTemplate,
  this.webAuthnConfiguration,
});