Interface ICfnUserProps

Properties for defining a CfnUser.

Namespace: Amazon.CDK.AWS.AppStream

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnUserProps

Syntax (vb)

Public Interface ICfnUserProps

Remarks

See: 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

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.

Properties

AuthenticationType

The authentication type for the user.

string AuthenticationType { get; }

Property Value

System.String

Remarks

You must specify USERPOOL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-authenticationtype

FirstName

The first name, or given name, of the user.

virtual string FirstName { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-firstname

LastName

The last name, or surname, of the user.

virtual string LastName { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-lastname

MessageAction

The action to take for the welcome email that is sent to a user after the user is created in the user pool.

virtual string MessageAction { get; }

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-messageaction

UserName

The email address of the user.

string UserName { get; }

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html#cfn-appstream-user-username