@aws-sdk/client-cognito-identity-provider

import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient"; import { CreateUserPoolRequest, CreateUserPoolResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateUserPoolCommand}. */ export interface CreateUserPoolCommandInput extends CreateUserPoolRequest { } /** * @public * * The output of {@link CreateUserPoolCommand}. */ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __MetadataBearer { } declare const CreateUserPoolCommand_base: { new (input: CreateUserPoolCommandInput): import("@smithy/smithy-client").CommandImpl<CreateUserPoolCommandInput, CreateUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: CreateUserPoolCommandInput): import("@smithy/smithy-client").CommandImpl<CreateUserPoolCommandInput, CreateUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <note> * This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers * require you to register an origination phone number before you can send SMS messages * to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a * phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. * Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must * receive SMS messages might not be able to sign up, activate their accounts, or sign * in. * If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Servicesservice, * Amazon Simple Notification Service might place your account in the SMS sandbox. In * <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox * mode</a> * , you can send messages only to verified phone * numbers. After you test your app while in the sandbox environment, you can move out * of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the Amazon Cognito * Developer Guide. * </note> * Creates a new Amazon Cognito user pool and sets the password policy for the * pool. * <important> * If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. * </important> * <note> * Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you must use IAM credentials to authorize requests, and you must * grant yourself the corresponding IAM permission in a policy. * * Learn more * * <ul> * <li> * * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> * * </li> * </ul> * </note> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, CreateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, CreateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import * const client = new CognitoIdentityProviderClient(config); * const input = { // CreateUserPoolRequest * PoolName: "STRING_VALUE", // required * Policies: { // UserPoolPolicyType * PasswordPolicy: { // PasswordPolicyType * MinimumLength: Number("int"), * RequireUppercase: true || false, * RequireLowercase: true || false, * RequireNumbers: true || false, * RequireSymbols: true || false, * PasswordHistorySize: Number("int"), * TemporaryPasswordValidityDays: Number("int"), * }, * }, * DeletionProtection: "ACTIVE" || "INACTIVE", * LambdaConfig: { // LambdaConfigType * PreSignUp: "STRING_VALUE", * CustomMessage: "STRING_VALUE", * PostConfirmation: "STRING_VALUE", * PreAuthentication: "STRING_VALUE", * PostAuthentication: "STRING_VALUE", * DefineAuthChallenge: "STRING_VALUE", * CreateAuthChallenge: "STRING_VALUE", * VerifyAuthChallengeResponse: "STRING_VALUE", * PreTokenGeneration: "STRING_VALUE", * UserMigration: "STRING_VALUE", * PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType * LambdaVersion: "V1_0" || "V2_0", // required * LambdaArn: "STRING_VALUE", // required * }, * CustomSMSSender: { // CustomSMSLambdaVersionConfigType * LambdaVersion: "V1_0", // required * LambdaArn: "STRING_VALUE", // required * }, * CustomEmailSender: { // CustomEmailLambdaVersionConfigType * LambdaVersion: "V1_0", // required * LambdaArn: "STRING_VALUE", // required * }, * KMSKeyID: "STRING_VALUE", * }, * AutoVerifiedAttributes: [ // VerifiedAttributesListType * "phone_number" || "email", * ], * AliasAttributes: [ // AliasAttributesListType * "phone_number" || "email" || "preferred_username", * ], * UsernameAttributes: [ // UsernameAttributesListType * "phone_number" || "email", * ], * SmsVerificationMessage: "STRING_VALUE", * EmailVerificationMessage: "STRING_VALUE", * EmailVerificationSubject: "STRING_VALUE", * VerificationMessageTemplate: { // VerificationMessageTemplateType * SmsMessage: "STRING_VALUE", * EmailMessage: "STRING_VALUE", * EmailSubject: "STRING_VALUE", * EmailMessageByLink: "STRING_VALUE", * EmailSubjectByLink: "STRING_VALUE", * DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE", * }, * SmsAuthenticationMessage: "STRING_VALUE", * MfaConfiguration: "OFF" || "ON" || "OPTIONAL", * UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType * AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType * "phone_number" || "email", * ], * }, * DeviceConfiguration: { // DeviceConfigurationType * ChallengeRequiredOnNewDevice: true || false, * DeviceOnlyRememberedOnUserPrompt: true || false, * }, * EmailConfiguration: { // EmailConfigurationType * SourceArn: "STRING_VALUE", * ReplyToEmailAddress: "STRING_VALUE", * EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER", * From: "STRING_VALUE", * ConfigurationSet: "STRING_VALUE", * }, * SmsConfiguration: { // SmsConfigurationType * SnsCallerArn: "STRING_VALUE", // required * ExternalId: "STRING_VALUE", * SnsRegion: "STRING_VALUE", * }, * UserPoolTags: { // UserPoolTagsType * "<keys>": "STRING_VALUE", * }, * AdminCreateUserConfig: { // AdminCreateUserConfigType * AllowAdminCreateUserOnly: true || false, * UnusedAccountValidityDays: Number("int"), * InviteMessageTemplate: { // MessageTemplateType * SMSMessage: "STRING_VALUE", * EmailMessage: "STRING_VALUE", * EmailSubject: "STRING_VALUE", * }, * }, * Schema: [ // SchemaAttributesListType * { // SchemaAttributeType * Name: "STRING_VALUE", * AttributeDataType: "String" || "Number" || "DateTime" || "Boolean", * DeveloperOnlyAttribute: true || false, * Mutable: true || false, * Required: true || false, * NumberAttributeConstraints: { // NumberAttributeConstraintsType * MinValue: "STRING_VALUE", * MaxValue: "STRING_VALUE", * }, * StringAttributeConstraints: { // StringAttributeConstraintsType * MinLength: "STRING_VALUE", * MaxLength: "STRING_VALUE", * }, * }, * ], * UserPoolAddOns: { // UserPoolAddOnsType * AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required * AdvancedSecurityAdditionalFlows: { // AdvancedSecurityAdditionalFlowsType * CustomAuthMode: "AUDIT" || "ENFORCED", * }, * }, * UsernameConfiguration: { // UsernameConfigurationType * CaseSensitive: true || false, // required * }, * AccountRecoverySetting: { // AccountRecoverySettingType * RecoveryMechanisms: [ // RecoveryMechanismsType * { // RecoveryOptionType * Priority: Number("int"), // required * Name: "verified_email" || "verified_phone_number" || "admin_only", // required * }, * ], * }, * }; * const command = new CreateUserPoolCommand(input); * const response = await client.send(command); * // { // CreateUserPoolResponse * // UserPool: { // UserPoolType * // Id: "STRING_VALUE", * // Name: "STRING_VALUE", * // Policies: { // UserPoolPolicyType * // PasswordPolicy: { // PasswordPolicyType * // MinimumLength: Number("int"), * // RequireUppercase: true || false, * // RequireLowercase: true || false, * // RequireNumbers: true || false, * // RequireSymbols: true || false, * // PasswordHistorySize: Number("int"), * // TemporaryPasswordValidityDays: Number("int"), * // }, * // }, * // DeletionProtection: "ACTIVE" || "INACTIVE", * // LambdaConfig: { // LambdaConfigType * // PreSignUp: "STRING_VALUE", * // CustomMessage: "STRING_VALUE", * // PostConfirmation: "STRING_VALUE", * // PreAuthentication: "STRING_VALUE", * // PostAuthentication: "STRING_VALUE", * // DefineAuthChallenge: "STRING_VALUE", * // CreateAuthChallenge: "STRING_VALUE", * // VerifyAuthChallengeResponse: "STRING_VALUE", * // PreTokenGeneration: "STRING_VALUE", * // UserMigration: "STRING_VALUE", * // PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType * // LambdaVersion: "V1_0" || "V2_0", // required * // LambdaArn: "STRING_VALUE", // required * // }, * // CustomSMSSender: { // CustomSMSLambdaVersionConfigType * // LambdaVersion: "V1_0", // required * // LambdaArn: "STRING_VALUE", // required * // }, * // CustomEmailSender: { // CustomEmailLambdaVersionConfigType * // LambdaVersion: "V1_0", // required * // LambdaArn: "STRING_VALUE", // required * // }, * // KMSKeyID: "STRING_VALUE", * // }, * // Status: "Enabled" || "Disabled", * // LastModifiedDate: new Date("TIMESTAMP"), * // CreationDate: new Date("TIMESTAMP"), * // SchemaAttributes: [ // SchemaAttributesListType * // { // SchemaAttributeType * // Name: "STRING_VALUE", * // AttributeDataType: "String" || "Number" || "DateTime" || "Boolean", * // DeveloperOnlyAttribute: true || false, * // Mutable: true || false, * // Required: true || false, * // NumberAttributeConstraints: { // NumberAttributeConstraintsType * // MinValue: "STRING_VALUE", * // MaxValue: "STRING_VALUE", * // }, * // StringAttributeConstraints: { // StringAttributeConstraintsType * // MinLength: "STRING_VALUE", * // MaxLength: "STRING_VALUE", * // }, * // }, * // ], * // AutoVerifiedAttributes: [ // VerifiedAttributesListType * // "phone_number" || "email", * // ], * // AliasAttributes: [ // AliasAttributesListType * // "phone_number" || "email" || "preferred_username", * // ], * // UsernameAttributes: [ // UsernameAttributesListType * // "phone_number" || "email", * // ], * // SmsVerificationMessage: "STRING_VALUE", * // EmailVerificationMessage: "STRING_VALUE", * // EmailVerificationSubject: "STRING_VALUE", * // VerificationMessageTemplate: { // VerificationMessageTemplateType * // SmsMessage: "STRING_VALUE", * // EmailMessage: "STRING_VALUE", * // EmailSubject: "STRING_VALUE", * // EmailMessageByLink: "STRING_VALUE", * // EmailSubjectByLink: "STRING_VALUE", * // DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE", * // }, * // SmsAuthenticationMessage: "STRING_VALUE", * // UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType * // AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType * // "phone_number" || "email", * // ], * // }, * // MfaConfiguration: "OFF" || "ON" || "OPTIONAL", * // DeviceConfiguration: { // DeviceConfigurationType * // ChallengeRequiredOnNewDevice: true || false, * // DeviceOnlyRememberedOnUserPrompt: true || false, * // }, * // EstimatedNumberOfUsers: Number("int"), * // EmailConfiguration: { // EmailConfigurationType * // SourceArn: "STRING_VALUE", * // ReplyToEmailAddress: "STRING_VALUE", * // EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER", * // From: "STRING_VALUE", * // ConfigurationSet: "STRING_VALUE", * // }, * // SmsConfiguration: { // SmsConfigurationType * // SnsCallerArn: "STRING_VALUE", // required * // ExternalId: "STRING_VALUE", * // SnsRegion: "STRING_VALUE", * // }, * // UserPoolTags: { // UserPoolTagsType * // "<keys>": "STRING_VALUE", * // }, * // SmsConfigurationFailure: "STRING_VALUE", * // EmailConfigurationFailure: "STRING_VALUE", * // Domain: "STRING_VALUE", * // CustomDomain: "STRING_VALUE", * // AdminCreateUserConfig: { // AdminCreateUserConfigType * // AllowAdminCreateUserOnly: true || false, * // UnusedAccountValidityDays: Number("int"), * // InviteMessageTemplate: { // MessageTemplateType * // SMSMessage: "STRING_VALUE", * // EmailMessage: "STRING_VALUE", * // EmailSubject: "STRING_VALUE", * // }, * // }, * // UserPoolAddOns: { // UserPoolAddOnsType * // AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required * // AdvancedSecurityAdditionalFlows: { // AdvancedSecurityAdditionalFlowsType * // CustomAuthMode: "AUDIT" || "ENFORCED", * // }, * // }, * // UsernameConfiguration: { // UsernameConfigurationType * // CaseSensitive: true || false, // required * // }, * // Arn: "STRING_VALUE", * // AccountRecoverySetting: { // AccountRecoverySettingType * // RecoveryMechanisms: [ // RecoveryMechanismsType * // { // RecoveryOptionType * // Priority: Number("int"), // required * // Name: "verified_email" || "verified_phone_number" || "admin_only", // required * // }, * // ], * // }, * // }, * // }; * * ``` * * @param CreateUserPoolCommandInput - {@link CreateUserPoolCommandInput} * @returns {@link CreateUserPoolCommandOutput} * @see {@link CreateUserPoolCommandInput} for command's `input` shape. * @see {@link CreateUserPoolCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link InternalErrorException} (server fault) * This exception is thrown when Amazon Cognito encounters an internal error. * * @throws {@link InvalidEmailRoleAccessPolicyException} (client fault) * This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP * status code: 400. * * @throws {@link InvalidParameterException} (client fault) * This exception is thrown when the Amazon Cognito service encounters an invalid * parameter. * * @throws {@link InvalidSmsRoleAccessPolicyException} (client fault) * This exception is returned when the role provided for SMS configuration doesn't have * permission to publish using Amazon SNS. * * @throws {@link InvalidSmsRoleTrustRelationshipException} (client fault) * This exception is thrown when the trust relationship is not valid for the role * provided for SMS configuration. This can happen if you don't trust * <code>cognito-idp.amazonaws.com</code> or the external ID provided in the role does * not match what is provided in the SMS configuration for the user pool. * * @throws {@link LimitExceededException} (client fault) * This exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource. * * @throws {@link NotAuthorizedException} (client fault) * This exception is thrown when a user isn't authorized. * * @throws {@link TooManyRequestsException} (client fault) * This exception is thrown when the user has made too many requests for a given * operation. * * @throws {@link UserPoolTaggingException} (client fault) * This exception is thrown when a user pool tag can't be set or updated. * * @throws {@link CognitoIdentityProviderServiceException} * Base exception class for all service exceptions from CognitoIdentityProvider service. * * @public * @example Example user pool with email and username sign-in * ```javascript * // The following example creates a user pool with all configurable properties set to an example value. The resulting user pool allows sign-in with username or email address, has optional MFA, and has a Lambda function assigned to each possible trigger. * const input = { * "AccountRecoverySetting": { * "RecoveryMechanisms": [ * { * "Name": "verified_email", * "Priority": 1 * } * ] * }, * "AdminCreateUserConfig": { * "AllowAdminCreateUserOnly": false, * "InviteMessageTemplate": { * "EmailMessage": "Your username is {username} and temporary password is {####}.", * "EmailSubject": "Your sign-in information", * "SMSMessage": "Your username is {username} and temporary password is {####}." * } * }, * "AliasAttributes": [ * "email" * ], * "AutoVerifiedAttributes": [ * "email" * ], * "DeletionProtection": "ACTIVE", * "DeviceConfiguration": { * "ChallengeRequiredOnNewDevice": true, * "DeviceOnlyRememberedOnUserPrompt": true * }, * "EmailConfiguration": { * "ConfigurationSet": "my-test-ses-configuration-set", * "EmailSendingAccount": "DEVELOPER", * "From": "support@example.com", * "ReplyToEmailAddress": "support@example.com", * "SourceArn": "arn:aws:ses:us-east-1:123456789012:identity/support@example.com" * }, * "EmailVerificationMessage": "Your verification code is {####}.", * "EmailVerificationSubject": "Verify your email address", * "LambdaConfig": { * "CustomEmailSender": { * "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "LambdaVersion": "V1_0" * }, * "CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "CustomSMSSender": { * "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "LambdaVersion": "V1_0" * }, * "DefineAuthChallenge": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "KMSKeyID": "arn:aws:kms:us-east-1:123456789012:key/a6c4f8e2-0c45-47db-925f-87854bc9e357", * "PostAuthentication": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PostConfirmation": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreAuthentication": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "VerifyAuthChallengeResponse": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" * }, * "MfaConfiguration": "OPTIONAL", * "Policies": { * "PasswordPolicy": { * "MinimumLength": 6, * "RequireLowercase": true, * "RequireNumbers": true, * "RequireSymbols": true, * "RequireUppercase": true, * "TemporaryPasswordValidityDays": 7 * } * }, * "PoolName": "my-test-user-pool", * "Schema": [ * { * "AttributeDataType": "Number", * "DeveloperOnlyAttribute": true, * "Mutable": true, * "Name": "mydev", * "NumberAttributeConstraints": { * "MaxValue": "99", * "MinValue": "1" * }, * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "99", * "MinLength": "1" * } * } * ], * "SmsAuthenticationMessage": "Your verification code is {####}.", * "SmsConfiguration": { * "ExternalId": "my-role-external-id", * "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role" * }, * "SmsVerificationMessage": "Your verification code is {####}.", * "UserAttributeUpdateSettings": { * "AttributesRequireVerificationBeforeUpdate": [ * "email" * ] * }, * "UserPoolAddOns": { * "AdvancedSecurityMode": "OFF" * }, * "UserPoolTags": { * "my-test-tag-key": "my-test-tag-key" * }, * "UsernameConfiguration": { * "CaseSensitive": true * }, * "VerificationMessageTemplate": { * "DefaultEmailOption": "CONFIRM_WITH_CODE", * "EmailMessage": "Your confirmation code is {####}", * "EmailMessageByLink": "Choose this link to {##verify your email##}", * "EmailSubject": "Here is your confirmation code", * "EmailSubjectByLink": "Here is your confirmation link", * "SmsMessage": "Your confirmation code is {####}" * } * }; * const command = new CreateUserPoolCommand(input); * const response = await client.send(command); * /* response == * { * "UserPool": { * "AccountRecoverySetting": { * "RecoveryMechanisms": [ * { * "Name": "verified_email", * "Priority": 1 * } * ] * }, * "AdminCreateUserConfig": { * "AllowAdminCreateUserOnly": false, * "InviteMessageTemplate": { * "EmailMessage": "Your username is {username} and temporary password is {####}.", * "EmailSubject": "Your sign-in information", * "SMSMessage": "Your username is {username} and temporary password is {####}." * }, * "UnusedAccountValidityDays": 7 * }, * "AliasAttributes": [ * "email" * ], * "Arn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_EXAMPLE", * "AutoVerifiedAttributes": [ * "email" * ], * "CreationDate": 1689721665.239, * "DeletionProtection": "ACTIVE", * "DeviceConfiguration": { * "ChallengeRequiredOnNewDevice": true, * "DeviceOnlyRememberedOnUserPrompt": true * }, * "EmailConfiguration": { * "ConfigurationSet": "my-test-ses-configuration-set", * "EmailSendingAccount": "DEVELOPER", * "From": "support@example.com", * "ReplyToEmailAddress": "support@example.com", * "SourceArn": "arn:aws:ses:us-east-1:123456789012:identity/support@example.com" * }, * "EmailVerificationMessage": "Your verification code is {####}.", * "EmailVerificationSubject": "Verify your email address", * "EstimatedNumberOfUsers": 0, * "Id": "us-east-1_EXAMPLE", * "LambdaConfig": { * "CustomEmailSender": { * "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "LambdaVersion": "V1_0" * }, * "CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "CustomSMSSender": { * "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "LambdaVersion": "V1_0" * }, * "DefineAuthChallenge": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "KMSKeyID": "arn:aws:kms:us-east-1:767671399759:key/4d43904c-8edf-4bb4-9fca-fb1a80e41cbe", * "PostAuthentication": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PostConfirmation": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreAuthentication": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", * "VerifyAuthChallengeResponse": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" * }, * "LastModifiedDate": 1689721665.239, * "MfaConfiguration": "OPTIONAL", * "Name": "my-test-user-pool", * "Policies": { * "PasswordPolicy": { * "MinimumLength": 6, * "RequireLowercase": true, * "RequireNumbers": true, * "RequireSymbols": true, * "RequireUppercase": true, * "TemporaryPasswordValidityDays": 7 * } * }, * "SchemaAttributes": [ * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": false, * "Name": "sub", * "Required": true, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "1" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "name", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "given_name", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "family_name", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "middle_name", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "nickname", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "preferred_username", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "profile", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "picture", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "website", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "email", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "Boolean", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "email_verified", * "Required": false * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "gender", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "birthdate", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "10", * "MinLength": "10" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "zoneinfo", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "locale", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "phone_number", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "Boolean", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "phone_number_verifie", * "Required": false * }, * { * "AttributeDataType": "String", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "address", * "Required": false, * "StringAttributeConstraints": { * "MaxLength": "2048", * "MinLength": "0" * } * }, * { * "AttributeDataType": "Number", * "DeveloperOnlyAttribute": false, * "Mutable": true, * "Name": "updated_at", * "NumberAttributeConstraints": { * "MinValue": "0" * }, * "Required": false * }, * { * "AttributeDataType": "Number", * "DeveloperOnlyAttribute": true, * "Mutable": true, * "Name": "dev:custom:mydev", * "NumberAttributeConstraints": { * "MaxValue": "99", * "MinValue": "1" * }, * "Required": false * } * ], * "SmsAuthenticationMessage": "Your verification code is {####}.", * "SmsConfiguration": { * "ExternalId": "my-role-external-id", * "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role", * "SnsRegion": "us-east-1" * }, * "SmsVerificationMessage": "Your verification code is {####}.", * "UserAttributeUpdateSettings": { * "AttributesRequireVerificationBeforeUpdate": [ * "email" * ] * }, * "UserPoolAddOns": { * "AdvancedSecurityMode": "OFF" * }, * "UserPoolTags": { * "my-test-tag-key": "my-test-tag-value" * }, * "UsernameConfiguration": { * "CaseSensitive": true * }, * "VerificationMessageTemplate": { * "DefaultEmailOption": "CONFIRM_WITH_CODE", * "EmailMessage": "Your confirmation code is {####}", * "EmailMessageByLink": "Choose this link to {##verify your email##}", * "EmailSubject": "Here is your confirmation code", * "EmailSubjectByLink": "Here is your confirmation link", * "SmsMessage": "Your confirmation code is {####}" * } * } * } * *\/ * // example id: example-user-pool-with-email-and-username-sign-in-1689722835145 * ``` * */ export declare class CreateUserPoolCommand extends CreateUserPoolCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateUserPoolRequest; output: CreateUserPoolResponse; }; sdk: { input: CreateUserPoolCommandInput; output: CreateUserPoolCommandOutput; }; }; }