Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon AppStream 2.0 Resource Types Reference » AWS::AppStream::User

AWS::AppStream::User

The AWS::AppStream::User resource creates a new user in the user pool for Amazon AppStream 2.0. For more information, see CreateUser in the Amazon AppStream 2.0 API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppStream::User",
  "Properties" : {
    "AuthenticationType" : String,
    "FirstName" : String,
    "LastName" : String,
    "MessageAction" : String,
    "UserName" : String
  }
}

YAML

Type: "AWS::AppStream::User"
Properties:
  AuthenticationType: String
  FirstName: String
  LastName: String
  MessageAction: String
  UserName: String

Properties

AuthenticationType

The authentication type for the user. You must specify USERPOOL.

Required: Yes

Type: String

Update requires: Replacement

FirstName

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

Required: No

Type: String

Update requires: Replacement

LastName

The last name, or surname, of the user.

Required: No

Type: String

Update requires: Replacement

MessageAction

The action to take for the welcome email that is sent to a user after the user is created in the user pool. 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.

Note

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.

Required: No

Type: String

Update requires: Replacement

UserName

The email address of the user.

Required: Yes

Type: String

Update requires: Replacement

See Also

  • CreateUser in the Amazon AppStream 2.0 API Reference

On this page: