Class CfnUser
A CloudFormation AWS::AppStream::User
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public class CfnUser : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUser
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
CloudformationResource: AWS::AppStream::User
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 cfnUser = new CfnUser(this, "MyCfnUser", new CfnUserProps {
AuthenticationType = "authenticationType",
UserName = "userName",
// the properties below are optional
FirstName = "firstName",
LastName = "lastName",
MessageAction = "messageAction"
});
Synopsis
Constructors
CfnUser(Construct, String, ICfnUserProps) | Create a new |
CfnUser(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUser(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AuthenticationType | The authentication type for the user. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUser(Construct, String, ICfnUserProps)
Create a new AWS::AppStream::User
.
public CfnUser(Construct scope, string id, ICfnUserProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserProps
- resource properties.
CfnUser(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUser(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUser(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUser(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AuthenticationType
The authentication type for the user.
public virtual string AuthenticationType { get; set; }
Property Value
System.String
Remarks
You must specify USERPOOL.
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
FirstName
The first name, or given name, of the user.
public virtual string FirstName { get; set; }
Property Value
System.String
Remarks
LastName
The last name, or surname, of the user.
public virtual 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 virtual 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 virtual 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.
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>