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>?

Attributes supported as an alias for this user pool. An alias is an attribute that users can enter as an alternative username. Possible values: phone_number, email, or preferred_username.

arn

var arn: String?

The Amazon Resource Name (ARN) of 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 when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

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.

emailVerificationSubject

var emailVerificationSubject: String?

This parameter is no longer used.

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?

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

lastModifiedDate

var lastModifiedDate: Instant?

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

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?

A list of user pool policies. Contains the policy that sets password-complexity requirements.

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?

User pool configuration for delivery of SMS messages with 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.

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. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

userPoolAddOns

var userPoolAddOns: UserPoolAddOnsType?

Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted 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.

userPoolTier

var userPoolTier: UserPoolTierType?

The user pool feature plan, or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS.

verificationMessageTemplate

var verificationMessageTemplate: VerificationMessageTemplateType?

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.