AWS::Cognito::UserPoolUser

The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user.

Syntax

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

JSON

{
  "Type" : "AWS::Cognito::UserPoolUser",
  "Properties" : {
      "ClientMetadata" : {Key: Value, ...},
      "DesiredDeliveryMediums" : [ String, ... ],
      "ForceAliasCreation" : Boolean,
      "MessageAction" : String,
      "UserAttributes" : [ AttributeType, ... ],
      "Username" : String,
      "UserPoolId" : String,
      "ValidationData" : [ AttributeType, ... ]
    }
}

YAML

Type: AWS::Cognito::UserPoolUser
Properties:
  ClientMetadata: 
    Key: Value
  DesiredDeliveryMediums: 
    - String
  ForceAliasCreation: Boolean
  MessageAction: String
  UserAttributes: 
    - AttributeType
  Username: String
  UserPoolId: String
  ValidationData: 
    - AttributeType

Properties

ClientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ClientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

Note

When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

Required: No

Type: Object of String

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

Update requires: Replacement

DesiredDeliveryMediums

Specify EMAIL if email will be used to send the welcome message. Specify SMS if the phone number will be used. The default value is SMS. You can specify more than one value.

Required: No

Type: Array of String

Update requires: Replacement

ForceAliasCreation

This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

Required: No

Type: Boolean

Update requires: Replacement

MessageAction

Set to RESEND to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to SUPPRESS to suppress sending the message. You can specify only one value.

Required: No

Type: String

Allowed values: RESEND | SUPPRESS

Update requires: Replacement

UserAttributes

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don't submit a TemporaryPassword.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True.

• email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

• phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.

Required: No

Type: Array of AttributeType

Update requires: Replacement

Username

The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.

• The username can't be a duplicate of another username in the same user pool.

• You can't change the value of a username after you create it.

• You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.

Required: No

Type: String

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Minimum: 1

Maximum: 128

Update requires: Replacement

UserPoolId

The ID of the user pool where you want to create a user.

Required: Yes

Type: String

Pattern: [\w-]+_[0-9a-zA-Z]+

Minimum: 1

Maximum: 55

Update requires: Replacement

ValidationData

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

Required: No

Type: Array of AttributeType

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the user. For example: admin.

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

Examples

Creating a new user in a user pool

The following example creates a new user with the username testuser.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Provision a new user to an Amazon Cognito user pool\n",
    "Resources": {
        "TestUser": {
            "Properties": {
                "DesiredDeliveryMediums": [
                    "SMS"
                ],
                "MessageAction": "SUPPRESS",
                "UserAttributes": [
                    {
                        "Name": "name",
                        "Value": "John"
                    },
                    {
                        "Name": "phone_number",
                        "Value": "[phone]"
                    },
                    {
                        "Name": "email",
                        "Value": "[e-mail]"
                    }
                ],
                "Username": "testuser",
                "UserPoolId": "us-west-2_EXAMPLE"
            },
            "Type": "AWS::Cognito::UserPoolUser"
        }
    }
}

YAML

AWSTemplateFormatVersion: "2010-09-09"

Description: |
  Provision a new user to an Amazon Cognito user pool

Resources:
  TestUser:
    Type: AWS::Cognito::UserPoolUser
    Properties:
      DesiredDeliveryMediums:
        - SMS
      MessageAction: SUPPRESS
      UserAttributes:
        - Name: name
          Value: John
        - Name: phone_number
          Value: "[phone]"
        - Name: email
          Value: [e-mail]
      Username: testuser
      UserPoolId: us-west-2_EXAMPLE