UserPoolType class

A container for information about the user pool.

Constructors

UserPoolType({AccountRecoverySettingType? accountRecoverySetting, AdminCreateUserConfigType? adminCreateUserConfig, List<AliasAttributeType>? aliasAttributes, String? arn, List<VerifiedAttributeType>? autoVerifiedAttributes, DateTime? creationDate, String? customDomain, DeviceConfigurationType? deviceConfiguration, String? domain, EmailConfigurationType? emailConfiguration, String? emailConfigurationFailure, String? emailVerificationMessage, String? emailVerificationSubject, int? estimatedNumberOfUsers, String? id, LambdaConfigType? lambdaConfig, DateTime? lastModifiedDate, UserPoolMfaType? mfaConfiguration, String? name, UserPoolPolicyType? policies, List<SchemaAttributeType>? schemaAttributes, String? smsAuthenticationMessage, SmsConfigurationType? smsConfiguration, String? smsConfigurationFailure, String? smsVerificationMessage, StatusType? status, UserPoolAddOnsType? userPoolAddOns, Map<String, String>? userPoolTags, List<UsernameAttributeType>? usernameAttributes, UsernameConfigurationType? usernameConfiguration, VerificationMessageTemplateType? verificationMessageTemplate})
UserPoolType.fromJson(Map<String, dynamic> json)
factory

Properties

accountRecoverySetting → AccountRecoverySettingType?
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.
final
adminCreateUserConfig → AdminCreateUserConfigType?
The configuration for AdminCreateUser requests.
final
aliasAttributes → List<AliasAttributeType>?
Specifies the attributes that are aliased in a user pool.
final
arn → String?
The Amazon Resource Name (ARN) for the user pool.
final
autoVerifiedAttributes → List<VerifiedAttributeType>?
Specifies the attributes that are auto-verified in a user pool.
final
creationDate → DateTime?
The date the user pool was created.
final
customDomain → String?
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.
final
deviceConfiguration → DeviceConfigurationType?
The device configuration.
final
domain → String?
Holds the domain prefix if the user pool has a domain associated with it.
final
emailConfiguration → EmailConfigurationType?
The email configuration.
final
emailConfigurationFailure → String?
The reason why the email configuration cannot send the messages to your users.
final
emailVerificationMessage → String?
The contents of the email verification message.
final
emailVerificationSubject → String?
The subject of the email verification message.
final
estimatedNumberOfUsers → int?
A number estimating the size of the user pool.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The ID of the user pool.
final
lambdaConfig → LambdaConfigType?
The AWS Lambda triggers associated with the user pool.
final
lastModifiedDate → DateTime?
The date the user pool was last modified.
final
mfaConfiguration → UserPoolMfaType?
Can be one of the following values:
final
name → String?
The name of the user pool.
final
policies → UserPoolPolicyType?
The policies associated with the user pool.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaAttributes → List<SchemaAttributeType>?
A container with the schema attributes of a user pool.
final
smsAuthenticationMessage → String?
The contents of the SMS authentication message.
final
smsConfiguration → SmsConfigurationType?
The SMS configuration.
final
smsConfigurationFailure → String?
The reason why the SMS configuration cannot send the messages to your users.
final
smsVerificationMessage → String?
The contents of the SMS verification message.
final
status → StatusType?
The status of a user pool.
final
usernameAttributes → List<UsernameAttributeType>?
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
final
usernameConfiguration → UsernameConfigurationType?
You can choose to enable 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. For more information, see UsernameConfigurationType.
final
userPoolAddOns → UserPoolAddOnsType?
The user pool add-ons.
final
userPoolTags → Map<String, String>?
The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
final
verificationMessageTemplate → VerificationMessageTemplateType?
The template for verification messages.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited