CfnUserProps Struct
Properties for defining a CfnUser.
| Source |
|---|
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const cfnUserProps: appstream.CfnUserProps = {
authenticationType: 'authenticationType',
userName: 'userName',
// the properties below are optional
firstName: 'firstName',
lastName: 'lastName',
messageAction: 'messageAction',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appstream as appstream
cfn_user_props = appstream.CfnUserProps(
authentication_type="authenticationType",
user_name="userName",
# the properties below are optional
first_name="firstName",
last_name="lastName",
message_action="messageAction"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appstream.*;
CfnUserProps cfnUserProps = CfnUserProps.builder()
.authenticationType("authenticationType")
.userName("userName")
// the properties below are optional
.firstName("firstName")
.lastName("lastName")
.messageAction("messageAction")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnUserProps := &CfnUserProps{
AuthenticationType: jsii.String("authenticationType"),
UserName: jsii.String("userName"),
// the properties below are optional
FirstName: jsii.String("firstName"),
LastName: jsii.String("lastName"),
MessageAction: jsii.String("messageAction"),
}
Properties
authenticationTypestringauthentication_typestrauthenticationTypeStringAuthenticationTypestringAuthenticationType*string required #The authentication type for the user.
You must specify USERPOOL.
firstNameoptionalstringfirst_nameoptionalstrfirstNameoptionalStringFirstNameoptionalstringFirstNameoptional*string #The first name, or given name, of the user.
lastNameoptionalstringlast_nameoptionalstrlastNameoptionalStringLastNameoptionalstringLastNameoptional*string #The last name, or surname, of the user.
messageActionoptionalstringmessage_actionoptionalstrmessageActionoptionalStringMessageActionoptionalstringMessageActionoptional*string #The action to take for the welcome email that is sent to a user after the user is created in the user pool.
notes
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.
The email address of the user.
notes
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.