CreateUserPoolRequest

import type { CreateUserPoolRequest } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";

Represents the request to create a user pool.

interface CreateUserPoolRequest {

AccountRecoverySetting?: AccountRecoverySettingType | null;

AdminCreateUserConfig?: AdminCreateUserConfigType | null;

AliasAttributes?: AliasAttributeType[] | null;

AutoVerifiedAttributes?: VerifiedAttributeType[] | null;

DeviceConfiguration?: DeviceConfigurationType | null;

EmailConfiguration?: EmailConfigurationType | null;

EmailVerificationMessage?: string | null;

EmailVerificationSubject?: string | null;

LambdaConfig?: LambdaConfigType | null;

MfaConfiguration?: UserPoolMfaType | null;

Policies?: UserPoolPolicyType | null;

PoolName: string;

Schema?: SchemaAttributeType[] | null;

SmsAuthenticationMessage?: string | null;

SmsConfiguration?: SmsConfigurationType | null;

SmsVerificationMessage?: string | null;

UsernameAttributes?: UsernameAttributeType[] | null;

UsernameConfiguration?: UsernameConfigurationType | null;

UserPoolAddOns?: UserPoolAddOnsType | null;

UserPoolTags?: {

[key: string]: string | null | undefined;

} | null;

VerificationMessageTemplate?: VerificationMessageTemplateType | null;

}

§Properties

AccountRecoverySetting?: AccountRecoverySettingType | null

[src]

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

AdminCreateUserConfig?: AdminCreateUserConfigType | null

[src]

The configuration for AdminCreateUser requests.

AliasAttributes?: AliasAttributeType[] | null

[src]

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

AutoVerifiedAttributes?: VerifiedAttributeType[] | null

[src]

The attributes to be auto-verified. Possible values: email, phone_number.

DeviceConfiguration?: DeviceConfigurationType | null

[src]

The device configuration.

EmailConfiguration?: EmailConfigurationType | null

[src]

The email configuration.

EmailVerificationMessage?: string | null

[src]

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

EmailVerificationSubject?: string | null

[src]

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

LambdaConfig?: LambdaConfigType | null

[src]

The Lambda trigger configuration information for the new user pool.

Note: In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission. For adding permission using the CLI, see add-permission.

MfaConfiguration?: UserPoolMfaType | null

[src]

Specifies MFA configuration details.

Policies?: UserPoolPolicyType | null

[src]

The policies associated with the new user pool.

PoolName: string

[src]

A string used to name the user pool.

Schema?: SchemaAttributeType[] | null

[src]

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

SmsAuthenticationMessage?: string | null

[src]

A string representing the SMS authentication message.

SmsConfiguration?: SmsConfigurationType | null

[src]

The SMS configuration.

SmsVerificationMessage?: string | null

[src]

A string representing the SMS verification message.

UsernameAttributes?: UsernameAttributeType[] | null

[src]

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

UsernameConfiguration?: UsernameConfigurationType | null

[src]

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

UserPoolAddOns?: UserPoolAddOnsType | null

[src]

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

UserPoolTags?: {

[key: string]: string | null | undefined;

} | null

[src]

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?: VerificationMessageTemplateType | null

[src]

The template for the verification message that the user sees when the app requests permission to access the user's information.