Class CfnUserPoolUser

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnUserPoolUser

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUserPoolUser : CfnResource, IInspectable

Syntax (vb)

Public Class CfnUserPoolUser Inherits CfnResource Implements IInspectable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

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

CfnUserPoolUser(Construct, string, ICfnUserPoolUserProps)

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

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user.
ClientMetadata	A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
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 to reset the temporary-password duration with a new temporary password.
UserAttributes	An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.
UserPoolId	The ID of the user pool where you want to create a user.
Username	The value that you want to set as the username sign-in attribute.
ValidationData	Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user.

Constructors

CfnUserPoolUser(Construct, string, ICfnUserPoolUserProps)

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

public CfnUserPoolUser(Construct scope, string id, ICfnUserPoolUserProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnUserPoolUserProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

ClientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

public virtual object? ClientMetadata { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

DesiredDeliveryMediums

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

public virtual string[]? DesiredDeliveryMediums { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

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

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

MessageAction

Set to RESEND to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password.

public virtual string? MessageAction { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

UserAttributes

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created.

public virtual object? UserAttributes { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

UserPoolId

The ID of the user pool where you want to create a user.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

Username

The value that you want to set as the username sign-in attribute.

public virtual string? Username { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

ValidationData

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.

public virtual object? ValidationData { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html

CloudformationResource: AWS::Cognito::UserPoolUser

ExampleMetadata: fixture=_generated

Implements

IInspectable