Class CfnUserPoolUserProps
Properties for defining a CfnUserPoolUser
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolUserProps : Object, ICfnUserPoolUserProps
Syntax (vb)
Public Class CfnUserPoolUserProps
Inherits Object
Implements ICfnUserPoolUserProps
Remarks
See: 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 cfnUserPoolUserProps = new CfnUserPoolUserProps {
UserPoolId = "userPoolId",
// the properties below are optional
ClientMetadata = new Dictionary<string, string> {
{ "clientMetadataKey", "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
Constructors
CfnUserPoolUserProps() |
Properties
ClientMetadata | A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. |
DesiredDeliveryMediums | Specify |
ForceAliasCreation | This parameter is used only if the |
MessageAction | Set to |
UserAttributes | An array of name-value pairs that contain user attributes and attribute values. |
Username | The value that you want to set as the username sign-in attribute. |
UserPoolId | The user pool ID for the user pool where the user will be created. |
ValidationData | Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. |
Constructors
CfnUserPoolUserProps()
public CfnUserPoolUserProps()
Properties
ClientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
public object ClientMetadata { get; set; }
Property Value
System.Object
Remarks
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, 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 parameter in your AdminCreateUser request. 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 .
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
DesiredDeliveryMediums
Specify "EMAIL"
if email will be used to send the welcome message.
public string[] DesiredDeliveryMediums { get; set; }
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
.
public object ForceAliasCreation { get; set; }
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.
public string MessageAction { get; set; }
Property Value
System.String
Remarks
Set to SUPPRESS
to suppress sending the message. You can specify only one value.
UserAttributes
An array of name-value pairs that contain user attributes and attribute values.
public object UserAttributes { get; set; }
Property Value
System.Object
Remarks
Username
The value that you want to set as the username sign-in attribute.
public string Username { get; set; }
Property Value
System.String
Remarks
The following conditions apply to the username parameter.
UserPoolId
The user pool ID for the user pool where the user will be created.
public string UserPoolId { get; set; }
Property Value
System.String
Remarks
ValidationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
public object ValidationData { get; set; }
Property Value
System.Object
Remarks
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 might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger .