Class CfnUser.Builder
java.lang.Object
software.amazon.awscdk.services.appstream.CfnUser.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUser>
- Enclosing class:
CfnUser
@Stability(Stable)
public static final class CfnUser.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUser>
A fluent builder for
CfnUser
.-
Method Summary
Modifier and TypeMethodDescriptionauthenticationType
(String authenticationType) The authentication type for the user.build()
static CfnUser.Builder
The first name, or given name, of the user.The last name, or surname, of the user.messageAction
(String messageAction) The action to take for the welcome email that is sent to a user after the user is created in the user pool.The email address of the user.
-
Method Details
-
create
@Stability(Stable) public static CfnUser.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnUser.Builder
.
-
authenticationType
The authentication type for the user.You must specify USERPOOL.
- Parameters:
authenticationType
- The authentication type for the user. This parameter is required.- Returns:
this
- See Also:
-
userName
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.
- Parameters:
userName
- The email address of the user. This parameter is required.- Returns:
this
- See Also:
-
firstName
The first name, or given name, of the user.- Parameters:
firstName
- The first name, or given name, of the user. This parameter is required.- Returns:
this
- See Also:
-
lastName
The last name, or surname, of the user.- Parameters:
lastName
- The last name, or surname, of the user. This parameter is required.- Returns:
this
- See Also:
-
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.
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.
- Parameters:
messageAction
- The action to take for the welcome email that is sent to a user after the user is created in the user pool. This parameter is required.- Returns:
this
- See Also:
-
build
-