Class CfnUserPoolUser
The AWS::Cognito::UserPoolUser
resource creates an Amazon Cognito user pool user.
Implements
Inherited Members
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(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 |
CfnUserPoolUser(Construct, String, ICfnUserPoolUserProps) |
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 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnUserPoolUser(Construct, String, ICfnUserPoolUserProps)
public CfnUserPoolUser(Construct scope, string id, ICfnUserPoolUserProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUserPoolUserProps
Resource properties.
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 any custom workflows that this action triggers.
public virtual object ClientMetadata { get; set; }
Property Value
System.Object
DesiredDeliveryMediums
Specify "EMAIL"
if email will be used to send the welcome message.
public virtual string[] DesiredDeliveryMediums { get; set; }
Property Value
System.String[]
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
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
UserAttributes
An array of name-value pairs that contain user attributes and attribute values.
public virtual object UserAttributes { get; set; }
Property Value
System.Object
Username
The value that you want to set as the username sign-in attribute.
public virtual string Username { get; set; }
Property Value
System.String
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
ValidationData
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
public virtual object ValidationData { get; set; }
Property Value
System.Object
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>