Skip to content

Create User Pool

cognitoidentityprovider_create_user_pool R Documentation

This action might generate an SMS text message

Description

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 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

Usage

cognitoidentityprovider_create_user_pool(PoolName, Policies,
  DeletionProtection, LambdaConfig, AutoVerifiedAttributes,
  AliasAttributes, UsernameAttributes, SmsVerificationMessage,
  EmailVerificationMessage, EmailVerificationSubject,
  VerificationMessageTemplate, SmsAuthenticationMessage, MfaConfiguration,
  UserAttributeUpdateSettings, DeviceConfiguration, EmailConfiguration,
  SmsConfiguration, UserPoolTags, AdminCreateUserConfig, Schema,
  UserPoolAddOns, UsernameConfiguration, AccountRecoverySetting)

Arguments

PoolName

[required] A string used to name the user pool.

Policies

The policies associated with the new user pool.

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 delete_user_pool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new delete_user_pool request after you deactivate deletion protection in an update_user_pool API request.

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 .

AutoVerifiedAttributes

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

AliasAttributes

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

UsernameAttributes

Specifies whether a user can use an email address or phone number as a username when they sign up.

SmsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

EmailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

EmailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

VerificationMessageTemplate

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

SmsAuthenticationMessage

A string representing the SMS authentication message.

MfaConfiguration

Specifies MFA configuration details.

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.

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 DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

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.

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.

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.

AdminCreateUserConfig

The configuration for admin_create_user requests.

Schema

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

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.

UsernameConfiguration

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to 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 (case insensitive) 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.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

AccountRecoverySetting

The available verified method a user can use to recover their password when they call forgot_password. 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.

Value

A list with the following syntax: 

list(
  UserPool = list(
    Id = "string",
    Name = "string",
    Policies = list(
      PasswordPolicy = list(
        MinimumLength = 123,
        RequireUppercase = TRUE|FALSE,
        RequireLowercase = TRUE|FALSE,
        RequireNumbers = TRUE|FALSE,
        RequireSymbols = TRUE|FALSE,
        PasswordHistorySize = 123,
        TemporaryPasswordValidityDays = 123
      )
    ),
    DeletionProtection = "ACTIVE"|"INACTIVE",
    LambdaConfig = list(
      PreSignUp = "string",
      CustomMessage = "string",
      PostConfirmation = "string",
      PreAuthentication = "string",
      PostAuthentication = "string",
      DefineAuthChallenge = "string",
      CreateAuthChallenge = "string",
      VerifyAuthChallengeResponse = "string",
      PreTokenGeneration = "string",
      UserMigration = "string",
      PreTokenGenerationConfig = list(
        LambdaVersion = "V1_0"|"V2_0",
        LambdaArn = "string"
      ),
      CustomSMSSender = list(
        LambdaVersion = "V1_0",
        LambdaArn = "string"
      ),
      CustomEmailSender = list(
        LambdaVersion = "V1_0",
        LambdaArn = "string"
      ),
      KMSKeyID = "string"
    ),
    Status = "Enabled"|"Disabled",
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    SchemaAttributes = list(
      list(
        Name = "string",
        AttributeDataType = "String"|"Number"|"DateTime"|"Boolean",
        DeveloperOnlyAttribute = TRUE|FALSE,
        Mutable = TRUE|FALSE,
        Required = TRUE|FALSE,
        NumberAttributeConstraints = list(
          MinValue = "string",
          MaxValue = "string"
        ),
        StringAttributeConstraints = list(
          MinLength = "string",
          MaxLength = "string"
        )
      )
    ),
    AutoVerifiedAttributes = list(
      "phone_number"|"email"
    ),
    AliasAttributes = list(
      "phone_number"|"email"|"preferred_username"
    ),
    UsernameAttributes = list(
      "phone_number"|"email"
    ),
    SmsVerificationMessage = "string",
    EmailVerificationMessage = "string",
    EmailVerificationSubject = "string",
    VerificationMessageTemplate = list(
      SmsMessage = "string",
      EmailMessage = "string",
      EmailSubject = "string",
      EmailMessageByLink = "string",
      EmailSubjectByLink = "string",
      DefaultEmailOption = "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"
    ),
    SmsAuthenticationMessage = "string",
    UserAttributeUpdateSettings = list(
      AttributesRequireVerificationBeforeUpdate = list(
        "phone_number"|"email"
      )
    ),
    MfaConfiguration = "OFF"|"ON"|"OPTIONAL",
    DeviceConfiguration = list(
      ChallengeRequiredOnNewDevice = TRUE|FALSE,
      DeviceOnlyRememberedOnUserPrompt = TRUE|FALSE
    ),
    EstimatedNumberOfUsers = 123,
    EmailConfiguration = list(
      SourceArn = "string",
      ReplyToEmailAddress = "string",
      EmailSendingAccount = "COGNITO_DEFAULT"|"DEVELOPER",
      From = "string",
      ConfigurationSet = "string"
    ),
    SmsConfiguration = list(
      SnsCallerArn = "string",
      ExternalId = "string",
      SnsRegion = "string"
    ),
    UserPoolTags = list(
      "string"
    ),
    SmsConfigurationFailure = "string",
    EmailConfigurationFailure = "string",
    Domain = "string",
    CustomDomain = "string",
    AdminCreateUserConfig = list(
      AllowAdminCreateUserOnly = TRUE|FALSE,
      UnusedAccountValidityDays = 123,
      InviteMessageTemplate = list(
        SMSMessage = "string",
        EmailMessage = "string",
        EmailSubject = "string"
      )
    ),
    UserPoolAddOns = list(
      AdvancedSecurityMode = "OFF"|"AUDIT"|"ENFORCED",
      AdvancedSecurityAdditionalFlows = list(
        CustomAuthMode = "AUDIT"|"ENFORCED"
      )
    ),
    UsernameConfiguration = list(
      CaseSensitive = TRUE|FALSE
    ),
    Arn = "string",
    AccountRecoverySetting = list(
      RecoveryMechanisms = list(
        list(
          Priority = 123,
          Name = "verified_email"|"verified_phone_number"|"admin_only"
        )
      )
    )
  )
)

Request syntax

svc$create_user_pool(
  PoolName = "string",
  Policies = list(
    PasswordPolicy = list(
      MinimumLength = 123,
      RequireUppercase = TRUE|FALSE,
      RequireLowercase = TRUE|FALSE,
      RequireNumbers = TRUE|FALSE,
      RequireSymbols = TRUE|FALSE,
      PasswordHistorySize = 123,
      TemporaryPasswordValidityDays = 123
    )
  ),
  DeletionProtection = "ACTIVE"|"INACTIVE",
  LambdaConfig = list(
    PreSignUp = "string",
    CustomMessage = "string",
    PostConfirmation = "string",
    PreAuthentication = "string",
    PostAuthentication = "string",
    DefineAuthChallenge = "string",
    CreateAuthChallenge = "string",
    VerifyAuthChallengeResponse = "string",
    PreTokenGeneration = "string",
    UserMigration = "string",
    PreTokenGenerationConfig = list(
      LambdaVersion = "V1_0"|"V2_0",
      LambdaArn = "string"
    ),
    CustomSMSSender = list(
      LambdaVersion = "V1_0",
      LambdaArn = "string"
    ),
    CustomEmailSender = list(
      LambdaVersion = "V1_0",
      LambdaArn = "string"
    ),
    KMSKeyID = "string"
  ),
  AutoVerifiedAttributes = list(
    "phone_number"|"email"
  ),
  AliasAttributes = list(
    "phone_number"|"email"|"preferred_username"
  ),
  UsernameAttributes = list(
    "phone_number"|"email"
  ),
  SmsVerificationMessage = "string",
  EmailVerificationMessage = "string",
  EmailVerificationSubject = "string",
  VerificationMessageTemplate = list(
    SmsMessage = "string",
    EmailMessage = "string",
    EmailSubject = "string",
    EmailMessageByLink = "string",
    EmailSubjectByLink = "string",
    DefaultEmailOption = "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"
  ),
  SmsAuthenticationMessage = "string",
  MfaConfiguration = "OFF"|"ON"|"OPTIONAL",
  UserAttributeUpdateSettings = list(
    AttributesRequireVerificationBeforeUpdate = list(
      "phone_number"|"email"
    )
  ),
  DeviceConfiguration = list(
    ChallengeRequiredOnNewDevice = TRUE|FALSE,
    DeviceOnlyRememberedOnUserPrompt = TRUE|FALSE
  ),
  EmailConfiguration = list(
    SourceArn = "string",
    ReplyToEmailAddress = "string",
    EmailSendingAccount = "COGNITO_DEFAULT"|"DEVELOPER",
    From = "string",
    ConfigurationSet = "string"
  ),
  SmsConfiguration = list(
    SnsCallerArn = "string",
    ExternalId = "string",
    SnsRegion = "string"
  ),
  UserPoolTags = list(
    "string"
  ),
  AdminCreateUserConfig = list(
    AllowAdminCreateUserOnly = TRUE|FALSE,
    UnusedAccountValidityDays = 123,
    InviteMessageTemplate = list(
      SMSMessage = "string",
      EmailMessage = "string",
      EmailSubject = "string"
    )
  ),
  Schema = list(
    list(
      Name = "string",
      AttributeDataType = "String"|"Number"|"DateTime"|"Boolean",
      DeveloperOnlyAttribute = TRUE|FALSE,
      Mutable = TRUE|FALSE,
      Required = TRUE|FALSE,
      NumberAttributeConstraints = list(
        MinValue = "string",
        MaxValue = "string"
      ),
      StringAttributeConstraints = list(
        MinLength = "string",
        MaxLength = "string"
      )
    )
  ),
  UserPoolAddOns = list(
    AdvancedSecurityMode = "OFF"|"AUDIT"|"ENFORCED",
    AdvancedSecurityAdditionalFlows = list(
      CustomAuthMode = "AUDIT"|"ENFORCED"
    )
  ),
  UsernameConfiguration = list(
    CaseSensitive = TRUE|FALSE
  ),
  AccountRecoverySetting = list(
    RecoveryMechanisms = list(
      list(
        Priority = 123,
        Name = "verified_email"|"verified_phone_number"|"admin_only"
      )
    )
  )
)

Examples

## Not run: 
# 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.
svc$create_user_pool(
  AccountRecoverySetting = list(
    RecoveryMechanisms = list(
      list(
        Name = "verified_email",
        Priority = 1L
      )
    )
  ),
  AdminCreateUserConfig = list(
    AllowAdminCreateUserOnly = FALSE,
    InviteMessageTemplate = list(
      EmailMessage = "Your username is {username} and temporary password is {####}.",
      EmailSubject = "Your sign-in information",
      SMSMessage = "Your username is {username} and temporary password is {####}."
    )
  ),
  AliasAttributes = list(
    "email"
  ),
  AutoVerifiedAttributes = list(
    "email"
  ),
  DeletionProtection = "ACTIVE",
  DeviceConfiguration = list(
    ChallengeRequiredOnNewDevice = TRUE,
    DeviceOnlyRememberedOnUserPrompt = TRUE
  ),
  EmailConfiguration = list(
    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 = list(
    CustomEmailSender = list(
      LambdaArn = "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
      LambdaVersion = "V1_0"
    ),
    CustomMessage = "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
    CustomSMSSender = list(
      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 = list(
    PasswordPolicy = list(
      MinimumLength = 6L,
      RequireLowercase = TRUE,
      RequireNumbers = TRUE,
      RequireSymbols = TRUE,
      RequireUppercase = TRUE,
      TemporaryPasswordValidityDays = 7L
    )
  ),
  PoolName = "my-test-user-pool",
  Schema = list(
    list(
      AttributeDataType = "Number",
      DeveloperOnlyAttribute = TRUE,
      Mutable = TRUE,
      Name = "mydev",
      NumberAttributeConstraints = list(
        MaxValue = "99",
        MinValue = "1"
      ),
      Required = FALSE,
      StringAttributeConstraints = list(
        MaxLength = "99",
        MinLength = "1"
      )
    )
  ),
  SmsAuthenticationMessage = "Your verification code is {####}.",
  SmsConfiguration = list(
    ExternalId = "my-role-external-id",
    SnsCallerArn = "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role"
  ),
  SmsVerificationMessage = "Your verification code is {####}.",
  UserAttributeUpdateSettings = list(
    AttributesRequireVerificationBeforeUpdate = list(
      "email"
    )
  ),
  UserPoolAddOns = list(
    AdvancedSecurityMode = "OFF"
  ),
  UserPoolTags = list(
    `my-test-tag-key` = "my-test-tag-key"
  ),
  UsernameConfiguration = list(
    CaseSensitive = TRUE
  ),
  VerificationMessageTemplate = list(
    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 {####}"
  )
)

## End(Not run)