AWS SDK Version 3 for .NET
API Reference

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 Services 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. This operation sets basic and advanced configuration options. You can create a user pool in the Amazon Cognito console to your preferences and use the output of DescribeUserPool to generate requests from that baseline.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.CreateUserPoolRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateUserPoolRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The CreateUserPoolRequest type exposes the following members

Constructors

NameDescription
Public Method CreateUserPoolRequest()

Properties

NameTypeDescription
Public Property 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 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.

Public Property AdminCreateUserConfig Amazon.CognitoIdentityProvider.Model.AdminCreateUserConfigType

Gets and sets the property AdminCreateUserConfig.

The configuration for AdminCreateUser requests. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.

Public Property 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. For more information about alias attributes, see Customizing sign-in attributes.

Public Property AutoVerifiedAttributes System.Collections.Generic.List<System.String>

Gets and sets the property AutoVerifiedAttributes.

The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up.

Public Property DeletionProtection Amazon.CognitoIdentityProvider.DeletionProtectionType

Gets and sets the property DeletionProtection.

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.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Public Property DeviceConfiguration Amazon.CognitoIdentityProvider.Model.DeviceConfigurationType

Gets and sets the property DeviceConfiguration.

The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more infor

Public Property 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.

Public Property EmailVerificationMessage System.String

Gets and sets the property EmailVerificationMessage.

This parameter is no longer used. See VerificationMessageTemplateType.

Public Property EmailVerificationSubject System.String

Gets and sets the property EmailVerificationSubject.

This parameter is no longer used. See VerificationMessageTemplateType.

Public Property LambdaConfig Amazon.CognitoIdentityProvider.Model.LambdaConfigType

Gets and sets the property LambdaConfig.

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

Public Property MfaConfiguration Amazon.CognitoIdentityProvider.UserPoolMfaType

Gets and sets the property MfaConfiguration.

Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

Public Property Policies Amazon.CognitoIdentityProvider.Model.UserPoolPolicyType

Gets and sets the property Policies.

The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.

Public Property PoolName System.String

Gets and sets the property PoolName.

A friendlhy name for your user pool.

Public Property Schema System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.SchemaAttributeType>

Gets and sets the property Schema.

An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes.

Public Property SmsAuthenticationMessage System.String

Gets and sets the property SmsAuthenticationMessage.

A string representing the SMS authentication message.

Public Property 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. For more information see SMS message settings.

Public Property SmsVerificationMessage System.String

Gets and sets the property SmsVerificationMessage.

This parameter is no longer used. See VerificationMessageTemplateType.

Public Property UserAttributeUpdateSettings Amazon.CognitoIdentityProvider.Model.UserAttributeUpdateSettingsType

Gets and sets the property UserAttributeUpdateSettings.

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.

Public 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. For more information, see Customizing sign-in attributes.

Public Property UsernameConfiguration Amazon.CognitoIdentityProvider.Model.UsernameConfigurationType

Gets and sets the property UsernameConfiguration.

Sets the case sensitivity option for sign-in usernames. When CaseSensitive is 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 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.

When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

This configuration is immutable after you set it.

Public Property 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 AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

Public Property 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.

Public Property UserPoolTier Amazon.CognitoIdentityProvider.UserPoolTierType

Gets and sets the property UserPoolTier.

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.

Public Property VerificationMessageTemplate Amazon.CognitoIdentityProvider.Model.VerificationMessageTemplateType

Gets and sets the property VerificationMessageTemplate.

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

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

Examples

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.

Example user pool with email and username sign-in


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;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5