cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/UpdateUserPoolRequest/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.

autoVerifiedAttributes

var autoVerifiedAttributes: List<VerifiedAttributeType>?

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

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.

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 email invitation and verification messages from your user pool.

emailVerificationMessage

var emailVerificationMessage: String?

This parameter is no longer used. See VerificationMessageTemplateType.

emailVerificationSubject

var emailVerificationSubject: String?

This parameter is no longer used. See VerificationMessageTemplateType.

lambdaConfig

var lambdaConfig: LambdaConfigType?

The Lambda configuration information from the request to update the user pool.

mfaConfiguration

var mfaConfiguration: UserPoolMfaType?

Possible values include:

policies

var policies: UserPoolPolicyType?

A container with the policies you want to update in a user pool.

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.

smsVerificationMessage

var smsVerificationMessage: String?

This parameter is no longer used. See VerificationMessageTemplateType.

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.

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.

userPoolId

var userPoolId: String?

The user pool ID for the user pool you want to update.

userPoolTags

var userPoolTags: Map<String, String>?

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

verificationMessageTemplate

var verificationMessageTemplate: VerificationMessageTemplateType?

The template for verification messages.