interface CfnUserProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppStream.CfnUserProps |
 Java | software.amazon.awscdk.services.appstream.CfnUserProps |
 Python | aws_cdk.aws_appstream.CfnUserProps |
 TypeScript | @aws-cdk/aws-appstream » CfnUserProps |
Properties for defining a CfnUser.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appstream from '@aws-cdk/aws-appstream';
const cfnUserProps: appstream.CfnUserProps = {
authenticationType: 'authenticationType',
userName: 'userName',
// the properties below are optional
firstName: 'firstName',
lastName: 'lastName',
messageAction: 'messageAction',
};
Properties
| Name | Type | Description |
|---|---|---|
| authentication | string | The authentication type for the user. |
| user | string | The email address of the user. |
| first | string | The first name, or given name, of the user. |
| last | string | The last name, or surname, of the user. |
| message | string | The action to take for the welcome email that is sent to a user after the user is created in the user pool. |
authenticationType
Type:
string
The authentication type for the user.
You must specify USERPOOL.
userName
Type:
string
The email address of the user.
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.
firstName?
Type:
string
(optional)
The first name, or given name, of the user.
lastName?
Type:
string
(optional)
The last name, or surname, of the user.
messageAction?
Type:
string
(optional)
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.
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.