GetUserPoolResult class

Result data returned by getUserPool.

Constructors

GetUserPoolResult({List<GetUserPoolAccountRecoverySetting>? accountRecoverySettings, List<GetUserPoolAdminCreateUserConfig>? adminCreateUserConfigs, String? arn, List<String>? autoVerifiedAttributes, String? creationDate, String? customDomain, String? deletionProtection, List<GetUserPoolDeviceConfiguration>? deviceConfigurations, String? domain, List<GetUserPoolEmailConfiguration>? emailConfigurations, int? estimatedNumberOfUsers, String? id, List<GetUserPoolLambdaConfig>? lambdaConfigs, String? lastModifiedDate, String? mfaConfiguration, String? name, String? region, List<GetUserPoolSchemaAttribute>? schemaAttributes, String? smsAuthenticationMessage, String? smsConfigurationFailure, String? smsVerificationMessage, Map<String, String>? tags, List<GetUserPoolUserPoolAddOn>? userPoolAddOns, String? userPoolId, Map<String, String>? userPoolTags, List<String>? usernameAttributes})
Creates a new GetUserPoolResult. accountRecoverySettings Optional. adminCreateUserConfigs Optional. arn ARN of the User Pool. autoVerifiedAttributes The attributes that are auto-verified in a user pool. creationDate The date and time, in ISO 8601 format, when the item 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. An example of a custom domain name might be 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. deviceConfigurations Optional. domain The domain prefix, if the user pool has a domain associated with it. emailConfigurations Optional. estimatedNumberOfUsers A number estimating the size of the user pool. id Optional. lambdaConfigs Optional. lastModifiedDate The date and time, in ISO 8601 format, when the item was modified. mfaConfiguration Can be one of the following values: OFF | ON | OPTIONAL name - Name of the attribute. region Optional. schemaAttributes Optional. smsAuthenticationMessage The contents of the SMS authentication message. smsConfigurationFailure The reason why the SMS configuration can't send the messages to your users. smsVerificationMessage The contents of the SMS authentication message. tags Map of tags assigned to the resource. userPoolAddOns Optional. userPoolId Optional. userPoolTags (Deprecated) Map of tags assigned to the resource. usernameAttributes Specifies whether a user can use an email address or phone number as a username when they sign up.
const
GetUserPoolResult.fromMap(Map<String, dynamic> map)
factory

Properties

accountRecoverySettings → List<GetUserPoolAccountRecoverySetting>?
final
adminCreateUserConfigs → List<GetUserPoolAdminCreateUserConfig>?
final
arn → String?
ARN of the User Pool.
final
autoVerifiedAttributes → List<String>?
The attributes that are auto-verified in a user pool.
final
creationDate → String?
The date and time, in ISO 8601 format, when the item 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. An example of a custom domain name might be auth.example.com.
final
deletionProtection → 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.
final
deviceConfigurations → List<GetUserPoolDeviceConfiguration>?
final
domain → String?
The domain prefix, if the user pool has a domain associated with it.
final
emailConfigurations → List<GetUserPoolEmailConfiguration>?
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?
final
lambdaConfigs → List<GetUserPoolLambdaConfig>?
final
lastModifiedDate → String?
The date and time, in ISO 8601 format, when the item was modified.
final
mfaConfiguration → String?
Can be one of the following values: OFF | ON | OPTIONAL
final
name → String?
  • Name of the attribute.
  • final
    region → String?
    final
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    schemaAttributes → List<GetUserPoolSchemaAttribute>?
    final
    smsAuthenticationMessage → String?
    The contents of the SMS authentication message.
    final
    smsConfigurationFailure → String?
    The reason why the SMS configuration can't send the messages to your users.
    final
    smsVerificationMessage → String?
    The contents of the SMS authentication message.
    final
    tags → Map<String, String>?
    Map of tags assigned to the resource.
    final
    usernameAttributes → List<String>?
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    final
    userPoolAddOns → List<GetUserPoolUserPoolAddOn>?
    final
    userPoolId → String?
    final
    userPoolTags → Map<String, String>?
    (Deprecated) Map of tags assigned to the resource.
    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