Class CfnUserPoolUser

A CloudFormation AWS::Cognito::UserPoolUser.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnUserPoolUser
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CfnUserPoolUser : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserPoolUser
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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

CloudformationResource: AWS::Cognito::UserPoolUser

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 cfnUserPoolUser = new CfnUserPoolUser(this, "MyCfnUserPoolUser", 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

Constructors

CfnUserPoolUser(Construct, String, ICfnUserPoolUserProps)

Create a new AWS::Cognito::UserPoolUser.
CfnUserPoolUser(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnUserPoolUser(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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 "EMAIL" if email will be used to send the welcome message.
ForceAliasCreation

This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
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.
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnUserPoolUser(Construct, String, ICfnUserPoolUserProps)

Create a new AWS::Cognito::UserPoolUser.

public CfnUserPoolUser(Construct scope, string id, ICfnUserPoolUserProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnUserPoolUserProps
  • resource properties.

CfnUserPoolUser(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnUserPoolUser(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnUserPoolUser(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnUserPoolUser(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

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.

public virtual object ClientMetadata { get; set; }
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:

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-clientmetadata

    DesiredDeliveryMediums

    Specify &quot;EMAIL&quot; if email will be used to send the welcome message.

    public virtual 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.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-desireddeliverymediums

    ForceAliasCreation

    This parameter is used only if the phone_number_verified or email_verified attribute is set to True .

    public virtual 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 .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-forcealiascreation

    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 virtual string MessageAction { get; set; }
    Property Value

    System.String

    Remarks

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

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-messageaction

    UserAttributes

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

    public virtual object UserAttributes { get; set; }
    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 .)

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userattributes

      Username

      The username for the user.

      public virtual string Username { get; set; }
      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.

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username

      UserPoolId

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

      public virtual string UserPoolId { get; set; }
      Property Value

      System.String

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-userpoolid

      ValidationData

      The user's validation data.

      public virtual object ValidationData { get; set; }
      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.

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-validationdata

      Methods

      Inspect(TreeInspector)

      Examines the CloudFormation resource and discloses attributes.

      public virtual void Inspect(TreeInspector inspector)
      Parameters
      inspector TreeInspector
      • tree inspector to collect and process attributes.

      RenderProperties(IDictionary<String, Object>)

      protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
      Parameters
      props System.Collections.Generic.IDictionary<System.String, System.Object>
      Returns

      System.Collections.Generic.IDictionary<System.String, System.Object>

      Overrides

      Implements

      Constructs.IConstruct