class CfnUserPoolUser (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPoolUser`
Java	`software.amazon.awscdk.services.cognito.CfnUserPoolUser`
Python	`aws_cdk.aws_cognito.CfnUserPoolUser`
TypeScript	`@aws-cdk/aws-cognito` » `CfnUserPoolUser`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Cognito::UserPoolUser.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';

declare const clientMetadata: any;
const cfnUserPoolUser = new cognito.CfnUserPoolUser(this, 'MyCfnUserPoolUser', {
  userPoolId: 'userPoolId',

  // the properties below are optional
  clientMetadata: clientMetadata,
  desiredDeliveryMediums: ['desiredDeliveryMediums'],
  forceAliasCreation: false,
  messageAction: 'messageAction',
  userAttributes: [{
    name: 'name',
    value: 'value',
  }],
  username: 'username',
  validationData: [{
    name: 'name',
    value: 'value',
  }],
});

Initializer

new CfnUserPoolUser(scope: Construct, id: string, props: CfnUserPoolUserProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnUserPoolUserProps — - resource properties.

Create a new AWS::Cognito::UserPoolUser.

Construct Props

Name	Type	Description
userPoolId	`string`	The user pool ID for the user pool where the user will be created.
clientMetadata?	`any`	A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger.
desiredDeliveryMediums?	`string[]`	Specify `"EMAIL"` if email will be used to send the welcome message.
forceAliasCreation?	`boolean \|` `IResolvable`	This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
messageAction?	`string`	Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
userAttributes?	`IResolvable` `\|` `IResolvable` `\|` `AttributeTypeProperty[]`	The user attributes and attribute values to be set for the user to be created.
username?	`string`	The username for the user.
validationData?	`IResolvable` `\|` `IResolvable` `\|` `AttributeTypeProperty[]`	The user's validation data.

userPoolId

Type: string

The user pool ID for the user pool where the user will be created.

clientMetadata?

Type: any (optional)

A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you create a UserPoolUser resource and include the ClientMetadata property, 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 property. 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 Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide .

Take the following limitations into consideration when you use the ClientMetadata parameter:

Amazon Cognito does not 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 does not include triggers, the ClientMetadata parameter serves no purpose.

Amazon Cognito does not validate the ClientMetadata value.

Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

desiredDeliveryMediums?

Type: string[] (optional)

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.

forceAliasCreation?

Type: boolean | IResolvable (optional)

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, the API call will migrate 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 .

messageAction?

Type: string (optional)

Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.

Set to SUPPRESS to suppress sending the message. You can specify only one value.

userAttributes?

Type: IResolvable | IResolvable | AttributeTypeProperty[] (optional)

The user attributes and attribute values to be set for the user to be created.

These are name-value pairs You can create a user without specifying any attributes other than Username . However, any attributes that you specify as required (in or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser ) or by the user (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. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

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 . (You can also do this by calling .)

email : The email address of the user to whom the message that contains the code and user name 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 user name will be sent. Required if the phone_number_verified attribute is set to True , or if "SMS" is specified in the DesiredDeliveryMediums parameter.

username?

Type: string (optional)

The username for the user.

Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.

validationData?

Type: IResolvable | IResolvable | AttributeTypeProperty[] (optional)

The user's validation data.

This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data isn't persisted.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
clientMetadata	`any`	A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
userPoolId	`string`	The user pool ID for the user pool where the user will be created.
desiredDeliveryMediums?	`string[]`	Specify `"EMAIL"` if email will be used to send the welcome message.
forceAliasCreation?	`boolean \|` `IResolvable`	This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
messageAction?	`string`	Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
userAttributes?	`IResolvable` `\|` `IResolvable` `\|` `AttributeTypeProperty[]`	The user attributes and attribute values to be set for the user to be created.
username?	`string`	The username for the user.
validationData?	`IResolvable` `\|` `IResolvable` `\|` `AttributeTypeProperty[]`	The user's validation data.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

clientMetadata

Type: any

A map of custom key-value pairs that you can provide as input for the custom workflow that is invoked by the pre sign-up trigger.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide .

Take the following limitations into consideration when you use the ClientMetadata parameter:

Amazon Cognito does not 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 does not include triggers, the ClientMetadata parameter serves no purpose.

Amazon Cognito does not validate the ClientMetadata value.

Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

userPoolId

Type: string

The user pool ID for the user pool where the user will be created.

desiredDeliveryMediums?

Type: string[] (optional)

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.

forceAliasCreation?

Type: boolean | IResolvable (optional)

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 False , the API throws an AliasExistsException error if the alias already exists. The default value is False .

messageAction?

Type: string (optional)

Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.

Set to SUPPRESS to suppress sending the message. You can specify only one value.

userAttributes?

Type: IResolvable | IResolvable | AttributeTypeProperty[] (optional)

The user attributes and attribute values to be set for the user to be created.

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

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 . (You can also do this by calling .)

email : The email address of the user to whom the message that contains the code and user name 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 user name will be sent. Required if the phone_number_verified attribute is set to True , or if "SMS" is specified in the DesiredDeliveryMediums parameter.

username?

Type: string (optional)

The username for the user.

Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.

validationData?

Type: IResolvable | IResolvable | AttributeTypeProperty[] (optional)

The user's validation data.

The user's validation data isn't persisted.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }