cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/UserPoolType/Builder

Builder

Properties

var accountRecoverySetting: AccountRecoverySettingType?

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

adminCreateUserConfig

var adminCreateUserConfig: AdminCreateUserConfigType?

The configuration for AdminCreateUser requests.

aliasAttributes

var aliasAttributes: List<AliasAttributeType>?

The attributes that are aliased in a user pool.

arn

var arn: String?

The Amazon Resource Name (ARN) for the user pool.

autoVerifiedAttributes

var autoVerifiedAttributes: List<VerifiedAttributeType>?

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

creationDate

var creationDate: Instant?

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

customDomain

var 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.

deletionProtection

var deletionProtection: DeletionProtectionType?

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.

deviceConfiguration

var deviceConfiguration: DeviceConfigurationType?

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

domain

var domain: String?

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

emailConfiguration

var emailConfiguration: EmailConfigurationType?

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

emailConfigurationFailure

var emailConfigurationFailure: String?

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

emailVerificationMessage

var emailVerificationMessage: String?

This parameter is no longer used. See VerificationMessageTemplateType.

emailVerificationSubject

var emailVerificationSubject: String?

This parameter is no longer used. See VerificationMessageTemplateType.

estimatedNumberOfUsers

var estimatedNumberOfUsers: Int

A number estimating the size of the user pool.

var id: String?

The ID of the user pool.

lambdaConfig

var lambdaConfig: LambdaConfigType?

The Lambda triggers associated with the user pool.

lastModifiedDate

var lastModifiedDate: Instant?

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

mfaConfiguration

var mfaConfiguration: UserPoolMfaType?

Can be one of the following values:

name

var name: String?

The name of the user pool.

policies

var policies: UserPoolPolicyType?

The policies associated with the user pool.

schemaAttributes

var schemaAttributes: List<SchemaAttributeType>?

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

smsAuthenticationMessage

var smsAuthenticationMessage: String?

The contents of the SMS authentication message.

smsConfiguration

var smsConfiguration: SmsConfigurationType?

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

smsConfigurationFailure

var smsConfigurationFailure: String?

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

smsVerificationMessage

var smsVerificationMessage: String?

This parameter is no longer used. See VerificationMessageTemplateType.

status

var ~~status~~: StatusType?

This parameter is no longer used.

userAttributeUpdateSettings

var userAttributeUpdateSettings: UserAttributeUpdateSettingsType?

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

usernameAttributes

var usernameAttributes: List<UsernameAttributeType>?

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

usernameConfiguration

var usernameConfiguration: UsernameConfigurationType?

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

userPoolAddOns

var userPoolAddOns: UserPoolAddOnsType?

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

userPoolTags

var 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.

verificationMessageTemplate

var verificationMessageTemplate: VerificationMessageTemplateType?

The template for verification messages.