Class CfnUser
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUser : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUser Inherits CfnResource Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
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) | The |
Properties
AttrId | The |
AuthenticationType | The authentication type for the user. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | The |
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>) | The |
Constructors
CfnUser(Construct, string, ICfnUserProps)
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
public CfnUser(Construct scope, string id, ICfnUserProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnUserProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
Properties
AttrId
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
AuthenticationType
The authentication type for the user.
public virtual string AuthenticationType { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
FirstName
The first name, or given name, of the user.
public virtual string? FirstName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
LastName
The last name, or surname, of the user.
public virtual string? LastName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
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
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
UserName
The email address of the user.
public virtual string UserName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
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-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::AppStream::User
resource creates a new user in the AppStream 2.0 user pool.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html
CloudformationResource: AWS::AppStream::User
ExampleMetadata: fixture=_generated