public static final class CfnUserPoolUser.Builder
extends java.lang.Object
CfnUserPoolUser
.Modifier and Type | Method and Description |
---|---|
CfnUserPoolUser |
build() |
CfnUserPoolUser.Builder |
clientMetadata(java.lang.Object clientMetadata)
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.
|
static CfnUserPoolUser.Builder |
create(Construct scope,
java.lang.String id) |
CfnUserPoolUser.Builder |
desiredDeliveryMediums(java.util.List<java.lang.String> desiredDeliveryMediums)
Specify `"EMAIL"` if email will be used to send the welcome message.
|
CfnUserPoolUser.Builder |
forceAliasCreation(java.lang.Boolean forceAliasCreation)
This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
|
CfnUserPoolUser.Builder |
forceAliasCreation(IResolvable forceAliasCreation)
This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` .
|
CfnUserPoolUser.Builder |
messageAction(java.lang.String messageAction)
Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
|
CfnUserPoolUser.Builder |
userAttributes(IResolvable userAttributes)
The user attributes and attribute values to be set for the user to be created.
|
CfnUserPoolUser.Builder |
userAttributes(java.util.List<? extends java.lang.Object> userAttributes)
The user attributes and attribute values to be set for the user to be created.
|
CfnUserPoolUser.Builder |
username(java.lang.String username)
The username for the user.
|
CfnUserPoolUser.Builder |
userPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where the user will be created.
|
CfnUserPoolUser.Builder |
validationData(IResolvable validationData)
The user's validation data.
|
CfnUserPoolUser.Builder |
validationData(java.util.List<? extends java.lang.Object> validationData)
The user's validation data.
|
public static CfnUserPoolUser.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnUserPoolUser.AttributeTypeProperty.Builder
.public CfnUserPoolUser.Builder userPoolId(java.lang.String userPoolId)
userPoolId
- The user pool ID for the user pool where the user will be created. This parameter is required.this
public CfnUserPoolUser.Builder clientMetadata(java.lang.Object clientMetadata)
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.
clientMetadata
- 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. This parameter is required.this
public CfnUserPoolUser.Builder desiredDeliveryMediums(java.util.List<java.lang.String> desiredDeliveryMediums)
Specify "SMS"
if the phone number will be used. The default value is "SMS"
. You can specify more than one value.
desiredDeliveryMediums
- Specify `"EMAIL"` if email will be used to send the welcome message. This parameter is required.this
public CfnUserPoolUser.Builder forceAliasCreation(java.lang.Boolean forceAliasCreation)
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
.
forceAliasCreation
- This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . This parameter is required.this
public CfnUserPoolUser.Builder forceAliasCreation(IResolvable forceAliasCreation)
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
.
forceAliasCreation
- This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . This parameter is required.this
public CfnUserPoolUser.Builder messageAction(java.lang.String messageAction)
Set to SUPPRESS
to suppress sending the message. You can specify only one value.
messageAction
- Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. This parameter is required.this
public CfnUserPoolUser.Builder userAttributes(IResolvable userAttributes)
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_verified
attribute is set to True
, or if "EMAIL"
is specified in the DesiredDeliveryMediums
parameter.phone_number_verified
attribute is set to True
, or if "SMS"
is specified in the DesiredDeliveryMediums
parameter.userAttributes
- The user attributes and attribute values to be set for the user to be created. This parameter is required.this
public CfnUserPoolUser.Builder userAttributes(java.util.List<? extends java.lang.Object> userAttributes)
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_verified
attribute is set to True
, or if "EMAIL"
is specified in the DesiredDeliveryMediums
parameter.phone_number_verified
attribute is set to True
, or if "SMS"
is specified in the DesiredDeliveryMediums
parameter.userAttributes
- The user attributes and attribute values to be set for the user to be created. This parameter is required.this
public CfnUserPoolUser.Builder username(java.lang.String username)
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.
username
- The username for the user. This parameter is required.this
public CfnUserPoolUser.Builder validationData(IResolvable validationData)
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.
validationData
- The user's validation data. This parameter is required.this
public CfnUserPoolUser.Builder validationData(java.util.List<? extends java.lang.Object> validationData)
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.
validationData
- The user's validation data. This parameter is required.this
public CfnUserPoolUser build()