Interface ICfnUserPoolUserProps
Properties for defining a CfnUserPoolUser
.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ICfnUserPoolUserProps
Syntax (vb)
Public Interface ICfnUserPoolUserProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var clientMetadata;
var cfnUserPoolUserProps = new CfnUserPoolUserProps {
UserPoolId = "userPoolId",
// the properties below are optional
ClientMetadata = clientMetadata,
DesiredDeliveryMediums = new [] { "desiredDeliveryMediums" },
ForceAliasCreation = false,
MessageAction = "messageAction",
UserAttributes = new [] { new AttributeTypeProperty {
Name = "name",
Value = "value"
} },
Username = "username",
ValidationData = new [] { new AttributeTypeProperty {
Name = "name",
Value = "value"
} }
};
Synopsis
Properties
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. |
DesiredDeliveryMediums | Specify |
ForceAliasCreation | This parameter is used only if the |
MessageAction | Set to |
UserAttributes | The user attributes and attribute values to be set for the user to be created. |
Username | The username for the user. |
UserPoolId | The user pool ID for the user pool where the user will be created. |
ValidationData | The user's validation data. |
Properties
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.
virtual object ClientMetadata { get; }
Property Value
System.Object
Remarks
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:
DesiredDeliveryMediums
Specify "EMAIL"
if email will be used to send the welcome message.
virtual string[] DesiredDeliveryMediums { get; }
Property Value
System.String[]
Remarks
Specify "SMS"
if the phone number will be used. The default value is "SMS"
. You can specify more than one value.
ForceAliasCreation
This parameter is used only if the phone_number_verified
or email_verified
attribute is set to True
.
virtual object ForceAliasCreation { get; }
Property Value
System.Object
Remarks
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
Set to RESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
virtual string MessageAction { get; }
Property Value
System.String
Remarks
Set to SUPPRESS
to suppress sending the message. You can specify only one value.
UserAttributes
The user attributes and attribute values to be set for the user to be created.
virtual object UserAttributes { get; }
Property Value
System.Object
Remarks
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 .)
Username
The username for the user.
virtual string Username { get; }
Property Value
System.String
Remarks
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.
UserPoolId
The user pool ID for the user pool where the user will be created.
string UserPoolId { get; }
Property Value
System.String
Remarks
ValidationData
The user's validation data.
virtual object ValidationData { get; }
Property Value
System.Object
Remarks
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.