AWS::Cognito::UserPool

The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool. For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools and CreateUserPool.

Note

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::Cognito::UserPool",
  "Properties" : {
      "AccountRecoverySetting" : AccountRecoverySetting,
      "AdminCreateUserConfig" : AdminCreateUserConfig,
      "AliasAttributes" : [ String, ... ],
      "AutoVerifiedAttributes" : [ String, ... ],
      "DeletionProtection" : String,
      "DeviceConfiguration" : DeviceConfiguration,
      "EmailAuthenticationMessage" : String,
      "EmailAuthenticationSubject" : String,
      "EmailConfiguration" : EmailConfiguration,
      "EmailVerificationMessage" : String,
      "EmailVerificationSubject" : String,
      "EnabledMfas" : [ String, ... ],
      "LambdaConfig" : LambdaConfig,
      "MfaConfiguration" : String,
      "Policies" : Policies,
      "Schema" : [ SchemaAttribute, ... ],
      "SmsAuthenticationMessage" : String,
      "SmsConfiguration" : SmsConfiguration,
      "SmsVerificationMessage" : String,
      "UserAttributeUpdateSettings" : UserAttributeUpdateSettings,
      "UsernameAttributes" : [ String, ... ],
      "UsernameConfiguration" : UsernameConfiguration,
      "UserPoolAddOns" : UserPoolAddOns,
      "UserPoolName" : String,
      "UserPoolTags" : {Key: Value, ...},
      "VerificationMessageTemplate" : VerificationMessageTemplate
    }
}

YAML


Type: AWS::Cognito::UserPool
Properties:
  AccountRecoverySetting: 
    AccountRecoverySetting
  AdminCreateUserConfig: 
    AdminCreateUserConfig
  AliasAttributes: 
    - String
  AutoVerifiedAttributes: 
    - String
  DeletionProtection: String
  DeviceConfiguration: 
    DeviceConfiguration
  EmailAuthenticationMessage: String
  EmailAuthenticationSubject: String
  EmailConfiguration: 
    EmailConfiguration
  EmailVerificationMessage: String
  EmailVerificationSubject: String
  EnabledMfas: 
    - String
  LambdaConfig: 
    LambdaConfig
  MfaConfiguration: String
  Policies: 
    Policies
  Schema: 
    - SchemaAttribute
  SmsAuthenticationMessage: String
  SmsConfiguration: 
    SmsConfiguration
  SmsVerificationMessage: String
  UserAttributeUpdateSettings: 
    UserAttributeUpdateSettings
  UsernameAttributes: 
    - String
  UsernameConfiguration: 
    UsernameConfiguration
  UserPoolAddOns: 
    UserPoolAddOns
  UserPoolName: String
  UserPoolTags: 
    Key: Value
  VerificationMessageTemplate: 
    VerificationMessageTemplate

Properties

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.

Required: No

Type: AccountRecoverySetting

Update requires: No interruption

AdminCreateUserConfig

The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

Required: No

Type: AdminCreateUserConfig

Update requires: No interruption

AliasAttributes

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

Required: No

Type: Array of String

Update requires: No interruption

AutoVerifiedAttributes

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

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: ACTIVE | INACTIVE

Update requires: No interruption

DeviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

Note

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

Required: No

Type: DeviceConfiguration

Update requires: No interruption

EmailAuthenticationMessage

Property description not available.

Required: No

Type: String

Minimum: 6

Maximum: 20000

Update requires: No interruption

EmailAuthenticationSubject

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 140

Update requires: No interruption

EmailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Region, and sender for messages from your user pool.

Required: No

Type: EmailConfiguration

Update requires: No interruption

EmailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Required: No

Type: String

Minimum: 6

Maximum: 20000

Update requires: No interruption

EmailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

Required: No

Type: String

Minimum: 1

Maximum: 140

Update requires: No interruption

EnabledMfas

Set enabled MFA options on a specified user pool. To disable all MFAs after it has been enabled, set MfaConfiguration to OFF and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF. After you enable SMS_MFA, you can only disable it by setting MfaConfiguration to OFF. Can be one of the following values:

SMS_MFA - Enables MFA with SMS for the user pool. To select this option, you must also provide values for SmsConfiguration.
SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool.
EMAIL_OTP - Enables MFA with email for the user pool. To select this option, you must provide values for EmailConfiguration and within those, set EmailSendingAccount to DEVELOPER.

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA | EMAIL_OTP

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: LambdaConfig

Update requires: No interruption

MfaConfiguration

The multi-factor authentication (MFA) configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Required: No

Type: String

Allowed values: OFF | ON | OPTIONAL

Update requires: No interruption

Policies

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

Required: No

Type: Policies

Update requires: No interruption

Schema

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

Required: No

Type: Array of SchemaAttribute

Minimum: 1

Maximum: 50

Update requires: No interruption

SmsAuthenticationMessage

The contents of the SMS authentication message.

Required: No

Type: String

Minimum: 6

Maximum: 140

Update requires: No interruption

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 Region that you want, the Amazon Cognito user pool uses an Amazon Identity and Access Management (IAM) role in your Amazon Web Services account.

Required: No

Type: SmsConfiguration

Update requires: No interruption

SmsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Required: No

Type: String

Minimum: 6

Maximum: 140

Update requires: No interruption

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.

Required: No

Type: UserAttributeUpdateSettings

Update requires: No interruption

UsernameAttributes

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

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: UsernameConfiguration

Update requires: No interruption

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.

Required: No

Type: UserPoolAddOns

Update requires: No interruption

UserPoolName

A string used to name the user pool.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

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.

Required: No

Type: Object of String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Update requires: No interruption

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.

Required: No

Type: VerificationMessageTemplate

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a generated ID, such as us-east-2_zgaEXAMPLE.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn: The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341.
ProviderName: A friendly name for the IdP.
ProviderURL: The URL of the provider of the Amazon Cognito user pool, specified as a String.
UserPoolId: The ID of the user pool.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

S3Configuration

AccountRecoverySetting