Class CfnUserProps
Properties for defining a CfnUser
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public class CfnUserProps : Object, ICfnUserProps
Syntax (vb)
Public Class CfnUserProps
Inherits Object
Implements ICfnUserProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.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.AppStream;
var cfnUserProps = new CfnUserProps {
AuthenticationType = "authenticationType",
UserName = "userName",
// the properties below are optional
FirstName = "firstName",
LastName = "lastName",
MessageAction = "messageAction"
};
Synopsis
Constructors
CfnUserProps() |
Properties
AuthenticationType | The authentication type for the user. |
FirstName | The first name, or given name, of the user. |
LastName | The last name, or surname, of the user. |
MessageAction | The action to take for the welcome email that is sent to a user after the user is created in the user pool. |
UserName | The email address of the user. |
Constructors
CfnUserProps()
public CfnUserProps()
Properties
AuthenticationType
The authentication type for the user.
public string AuthenticationType { get; set; }
Property Value
System.String
Remarks
You must specify USERPOOL.
FirstName
The first name, or given name, of the user.
public string FirstName { get; set; }
Property Value
System.String
Remarks
LastName
The last name, or surname, of the user.
public string LastName { get; set; }
Property Value
System.String
Remarks
MessageAction
The action to take for the welcome email that is sent to a user after the user is created in the user pool.
public string MessageAction { get; set; }
Property Value
System.String
Remarks
If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
UserName
The email address of the user.
public string UserName { get; set; }
Property Value
System.String
Remarks
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.