AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateUserPool operation.
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 Amazon
Pinpoint. 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
Service, Amazon Simple Notification Service might place your account in the SMS sandbox.
In sandbox
mode, 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
SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer
Guide.
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
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
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class CreateUserPoolRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The CreateUserPoolRequest type exposes the following members
Name | Description | |
---|---|---|
CreateUserPoolRequest() |
Name | Type | Description | |
---|---|---|---|
AccountRecoverySetting | Amazon.CognitoIdentityProvider.Model.AccountRecoverySettingType |
Gets and sets the property AccountRecoverySetting.
The available verified method a user can use to recover their password when they call
|
|
AdminCreateUserConfig | Amazon.CognitoIdentityProvider.Model.AdminCreateUserConfigType |
Gets and sets the property AdminCreateUserConfig.
The configuration for |
|
AliasAttributes | System.Collections.Generic.List<System.String> |
Gets and sets the property AliasAttributes. Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. |
|
AutoVerifiedAttributes | System.Collections.Generic.List<System.String> |
Gets and sets the property AutoVerifiedAttributes. The attributes to be auto-verified. Possible values: email, phone_number. |
|
DeletionProtection | Amazon.CognitoIdentityProvider.DeletionProtectionType |
Gets and sets the property DeletionProtection.
When active,
When you try to delete a protected user pool in a |
|
DeviceConfiguration | Amazon.CognitoIdentityProvider.Model.DeviceConfigurationType |
Gets and sets the property DeviceConfiguration. The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any |
|
EmailConfiguration | Amazon.CognitoIdentityProvider.Model.EmailConfigurationType |
Gets and sets the property EmailConfiguration. 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. |
|
EmailVerificationMessage | System.String |
Gets and sets the property EmailVerificationMessage. This parameter is no longer used. See VerificationMessageTemplateType. |
|
EmailVerificationSubject | System.String |
Gets and sets the property EmailVerificationSubject. This parameter is no longer used. See VerificationMessageTemplateType. |
|
LambdaConfig | Amazon.CognitoIdentityProvider.Model.LambdaConfigType |
Gets and sets the property LambdaConfig. The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must 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 | Amazon.CognitoIdentityProvider.UserPoolMfaType |
Gets and sets the property MfaConfiguration. Specifies MFA configuration details. |
|
Policies | Amazon.CognitoIdentityProvider.Model.UserPoolPolicyType |
Gets and sets the property Policies. The policies associated with the new user pool. |
|
PoolName | System.String |
Gets and sets the property PoolName. A string used to name the user pool. |
|
Schema | System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.SchemaAttributeType> |
Gets and sets the property Schema. An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. |
|
SmsAuthenticationMessage | System.String |
Gets and sets the property SmsAuthenticationMessage. A string representing the SMS authentication message. |
|
SmsConfiguration | Amazon.CognitoIdentityProvider.Model.SmsConfigurationType |
Gets and sets the property SmsConfiguration. 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 | System.String |
Gets and sets the property SmsVerificationMessage. This parameter is no longer used. See VerificationMessageTemplateType. |
|
UserAttributeUpdateSettings | Amazon.CognitoIdentityProvider.Model.UserAttributeUpdateSettingsType |
Gets and sets the property UserAttributeUpdateSettings.
The settings for updates to user attributes. These settings include the property |
|
UsernameAttributes | System.Collections.Generic.List<System.String> |
Gets and sets the property UsernameAttributes. Specifies whether a user can use an email address or phone number as a username when they sign up. |
|
UsernameConfiguration | Amazon.CognitoIdentityProvider.Model.UsernameConfigurationType |
Gets and sets the property UsernameConfiguration.
Case sensitivity on the username input for the selected sign-in option. When case
sensitivity is set to This configuration is immutable after you set it. For more information, see UsernameConfigurationType. |
|
UserPoolAddOns | Amazon.CognitoIdentityProvider.Model.UserPoolAddOnsType |
Gets and sets the property UserPoolAddOns.
User pool add-ons. Contains settings for activation of advanced security features.
To log user security information but take no action, set to For more information, see Adding advanced security to a user pool. |
|
UserPoolTags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property UserPoolTags. 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 | Amazon.CognitoIdentityProvider.Model.VerificationMessageTemplateType |
Gets and sets the property VerificationMessageTemplate. The template for the verification message that the user sees when the app requests permission to access the user's information. |
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.
var client = new AmazonCognitoIdentityProviderClient(); var response = client.CreateUserPool(new CreateUserPoolRequest { AccountRecoverySetting = new AccountRecoverySettingType { RecoveryMechanisms = new List<RecoveryOptionType> { new RecoveryOptionType { Name = "verified_email", Priority = 1 } } }, AdminCreateUserConfig = new AdminCreateUserConfigType { AllowAdminCreateUserOnly = false, InviteMessageTemplate = new MessageTemplateType { EmailMessage = "Your username is {username} and temporary password is {####}.", EmailSubject = "Your sign-in information", SMSMessage = "Your username is {username} and temporary password is {####}." } }, AliasAttributes = new List<string> { "email" }, AutoVerifiedAttributes = new List<string> { "email" }, DeletionProtection = "ACTIVE", DeviceConfiguration = new DeviceConfigurationType { ChallengeRequiredOnNewDevice = true, DeviceOnlyRememberedOnUserPrompt = true }, EmailConfiguration = new EmailConfigurationType { 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 = new LambdaConfigType { CustomEmailSender = new CustomEmailLambdaVersionConfigType { LambdaArn = "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", LambdaVersion = "V1_0" }, CustomMessage = "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", CustomSMSSender = new CustomSMSLambdaVersionConfigType { 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 = new UserPoolPolicyType { PasswordPolicy = new PasswordPolicyType { MinimumLength = 6, RequireLowercase = true, RequireNumbers = true, RequireSymbols = true, RequireUppercase = true, TemporaryPasswordValidityDays = 7 } }, PoolName = "my-test-user-pool", Schema = new List<SchemaAttributeType> { new SchemaAttributeType { AttributeDataType = "Number", DeveloperOnlyAttribute = true, Mutable = true, Name = "mydev", NumberAttributeConstraints = new NumberAttributeConstraintsType { MaxValue = "99", MinValue = "1" }, Required = false, StringAttributeConstraints = new StringAttributeConstraintsType { MaxLength = "99", MinLength = "1" } } }, SmsAuthenticationMessage = "Your verification code is {####}.", SmsConfiguration = new SmsConfigurationType { ExternalId = "my-role-external-id", SnsCallerArn = "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role" }, SmsVerificationMessage = "Your verification code is {####}.", UserAttributeUpdateSettings = new UserAttributeUpdateSettingsType { AttributesRequireVerificationBeforeUpdate = new List<string> { "email" } }, UserPoolAddOns = new UserPoolAddOnsType { AdvancedSecurityMode = "OFF" }, UserPoolTags = new Dictionary<string, string> { { "my-test-tag-key", "my-test-tag-key" } }, UsernameConfiguration = new UsernameConfigurationType { CaseSensitive = true }, VerificationMessageTemplate = new VerificationMessageTemplateType { 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 {####}" } }); UserPoolType userPool = response.UserPool;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5