Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:17.389Z")
@Stability(Stable)
public interface CfnUserPoolUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolUser.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolUserProps cfnUserPoolUserProps = CfnUserPoolUserProps.builder()
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientMetadata(Map.of(
                 "clientMetadataKey", "clientMetadata"))
         .desiredDeliveryMediums(List.of("desiredDeliveryMediums"))
         .forceAliasCreation(false)
         .messageAction("messageAction")
         .userAttributes(List.of(AttributeTypeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .username("username")
         .validationData(List.of(AttributeTypeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolUserProps.Builder	A builder for CfnUserPoolUserProps
static final class	CfnUserPoolUserProps.Jsii$Proxy	An implementation for CfnUserPoolUserProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolUserProps.Builder	builder()
default Object	getClientMetadata()	A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
default List<String>	getDesiredDeliveryMediums()	Specify EMAIL if email will be used to send the welcome message.
default Object	getForceAliasCreation()	This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
default String	getMessageAction()	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.
default Object	getUserAttributes()	An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
default String	getUsername()	The value that you want to set as the username sign-in attribute.
Object	getUserPoolId()	The ID of the user pool where you want to create a user.
default Object	getValidationData()	Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPoolId

@Stability(Stable)
@NotNull
Object getUserPoolId()

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

Returns union: either String or IUserPoolRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid

getClientMetadata

@Stability(Stable)
@Nullable
default Object getClientMetadata()

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 Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide .

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.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata

getDesiredDeliveryMediums

@Stability(Stable)
@Nullable
default List<String> getDesiredDeliveryMediums()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums

getForceAliasCreation

@Stability(Stable)
@Nullable
default Object getForceAliasCreation()

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 .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation

getMessageAction

@Stability(Stable)
@Nullable
default String getMessageAction()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction

getUserAttributes

@Stability(Stable)
@Nullable
default Object getUserAttributes()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUserPoolUser.AttributeTypeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes

getUsername

@Stability(Stable)
@Nullable
default String getUsername()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username

getValidationData

@Stability(Stable)
@Nullable
default Object getValidationData()

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUserPoolUser.AttributeTypeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata

builder

@Stability(Stable)
static CfnUserPoolUserProps.Builder builder()

Returns:

a CfnUserPoolUserProps.Builder of CfnUserPoolUserProps