software.amazon.awscdk.services.cognito

Class CfnUserPoolUser

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolUser

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.548Z")
public class CfnUserPoolUser
extends CfnResource
implements 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 software.amazon.awscdk.services.cognito.*;
 Object clientMetadata;
 CfnUserPoolUser cfnUserPoolUser = CfnUserPoolUser.Builder.create(this, "MyCfnUserPoolUser")
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientMetadata(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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnUserPoolUser.AttributeTypeProperty Specifies whether the attribute is standard or custom.
static class	CfnUserPoolUser.Builder A fluent builder for CfnUserPoolUser.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolUser(Construct scope, java.lang.String id, CfnUserPoolUserProps props) Create a new `AWS::Cognito::UserPoolUser`.
protected	CfnUserPoolUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolUser(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getClientMetadata() 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.
java.util.List<java.lang.String>	getDesiredDeliveryMediums() Specify `"EMAIL"` if email will be used to send the welcome message.
java.lang.Object	getForceAliasCreation() This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
java.lang.String	getMessageAction() Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
java.lang.Object	getUserAttributes() The user attributes and attribute values to be set for the user to be created.
java.lang.String	getUsername() The username for the user.
java.lang.String	getUserPoolId() The user pool ID for the user pool where the user will be created.
java.lang.Object	getValidationData() The user's validation data.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setClientMetadata(java.lang.Object value) 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.
void	setDesiredDeliveryMediums(java.util.List<java.lang.String> value) Specify `"EMAIL"` if email will be used to send the welcome message.
void	setForceAliasCreation(java.lang.Boolean value) This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
void	setForceAliasCreation(IResolvable value) This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
void	setMessageAction(java.lang.String value) Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
void	setUserAttributes(IResolvable value) The user attributes and attribute values to be set for the user to be created.
void	setUserAttributes(java.util.List<java.lang.Object> value) The user attributes and attribute values to be set for the user to be created.
void	setUsername(java.lang.String value) The username for the user.
void	setUserPoolId(java.lang.String value) The user pool ID for the user pool where the user will be created.
void	setValidationData(IResolvable value) The user's validation data.
void	setValidationData(java.util.List<java.lang.Object> value) The user's validation data.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolUser

protected CfnUserPoolUser(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolUser

protected CfnUserPoolUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolUser

public CfnUserPoolUser(Construct scope,
                       java.lang.String id,
                       CfnUserPoolUserProps props)

Create a new `AWS::Cognito::UserPoolUser`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClientMetadata

public java.lang.Object getClientMetadata()

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.

setClientMetadata

public void setClientMetadata(java.lang.Object value)

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.

getUserPoolId

public java.lang.String getUserPoolId()

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

setUserPoolId

public void setUserPoolId(java.lang.String value)

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

getDesiredDeliveryMediums

public java.util.List<java.lang.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.

setDesiredDeliveryMediums

public void setDesiredDeliveryMediums(java.util.List<java.lang.String> value)

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.

getForceAliasCreation

public java.lang.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, 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 .

setForceAliasCreation

public void setForceAliasCreation(java.lang.Boolean value)

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 .

setForceAliasCreation

public void setForceAliasCreation(IResolvable value)

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 .

getMessageAction

public java.lang.String getMessageAction()

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.

setMessageAction

public void setMessageAction(java.lang.String value)

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.

getUserAttributes

public java.lang.Object getUserAttributes()

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.

setUserAttributes

public void setUserAttributes(IResolvable value)

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.

setUserAttributes

public void setUserAttributes(java.util.List<java.lang.Object> value)

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.

getUsername

public java.lang.String getUsername()

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.

setUsername

public void setUsername(java.lang.String value)

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.

getValidationData

public java.lang.Object getValidationData()

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.

setValidationData

public void setValidationData(IResolvable value)

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.

setValidationData

public void setValidationData(java.util.List<java.lang.Object> value)

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.