GetUserPoolResult

data class GetUserPoolResult(val accountRecoverySettings: List<GetUserPoolAccountRecoverySetting>, val adminCreateUserConfigs: List<GetUserPoolAdminCreateUserConfig>, val arn: String, val autoVerifiedAttributes: List<String>, val creationDate: String, val customDomain: String, val deletionProtection: String, val deviceConfigurations: List<GetUserPoolDeviceConfiguration>, val domain: String, val emailConfigurations: List<GetUserPoolEmailConfiguration>, val estimatedNumberOfUsers: Int, val id: String, val lambdaConfigs: List<GetUserPoolLambdaConfig>, val lastModifiedDate: String, val mfaConfiguration: String, val name: String, val schemaAttributes: List<GetUserPoolSchemaAttribute>, val smsAuthenticationMessage: String, val smsConfigurationFailure: String, val smsVerificationMessage: String, val tags: Map<String, String>, val userPoolAddOns: List<GetUserPoolUserPoolAddOn>, val userPoolId: String, val userPoolTags: Map<String, String>, val usernameAttributes: List<String>)

A collection of values returned by getUserPool.

Constructors

Link copied to clipboard
constructor(accountRecoverySettings: List<GetUserPoolAccountRecoverySetting>, adminCreateUserConfigs: List<GetUserPoolAdminCreateUserConfig>, arn: String, autoVerifiedAttributes: List<String>, creationDate: String, customDomain: String, deletionProtection: String, deviceConfigurations: List<GetUserPoolDeviceConfiguration>, domain: String, emailConfigurations: List<GetUserPoolEmailConfiguration>, estimatedNumberOfUsers: Int, id: String, lambdaConfigs: List<GetUserPoolLambdaConfig>, lastModifiedDate: String, mfaConfiguration: String, name: String, schemaAttributes: List<GetUserPoolSchemaAttribute>, smsAuthenticationMessage: String, smsConfigurationFailure: String, smsVerificationMessage: String, tags: Map<String, String>, userPoolAddOns: List<GetUserPoolUserPoolAddOn>, userPoolId: String, userPoolTags: Map<String, String>, usernameAttributes: List<String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

ARN of the User Pool.

Link copied to clipboard

The attributes that are auto-verified in a user pool.

Link copied to clipboard

The date and time, in ISO 8601 format, when the item was created.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The domain prefix, if the user pool has a domain associated with it.

Link copied to clipboard

A number estimating the size of the user pool.

Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard

The date and time, in ISO 8601 format, when the item was modified.

Link copied to clipboard

Can be one of the following values: OFF | ON | OPTIONAL

Link copied to clipboard
Link copied to clipboard

The contents of the SMS authentication message.

Link copied to clipboard

The reason why the SMS configuration can't send the messages to your users.

Link copied to clipboard

The contents of the SMS authentication message.

Link copied to clipboard

Map of tags assigned to the resource.

Link copied to clipboard

Specifies whether a user can use an email address or phone number as a username when they sign up.

Link copied to clipboard
Link copied to clipboard

(Deprecated) Map of tags assigned to the resource.