Class CfnUserProps.Builder
java.lang.Object
software.amazon.awscdk.services.appstream.CfnUserProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserProps>
- Enclosing interface:
CfnUserProps
@Stability(Stable)
public static final class CfnUserProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserProps>
A builder for
CfnUserProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationType
(String authenticationType) Sets the value ofCfnUserProps.getAuthenticationType()
build()
Builds the configured instance.Sets the value ofCfnUserProps.getFirstName()
Sets the value ofCfnUserProps.getLastName()
messageAction
(String messageAction) Sets the value ofCfnUserProps.getMessageAction()
Sets the value ofCfnUserProps.getUserName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authenticationType
Sets the value ofCfnUserProps.getAuthenticationType()
- Parameters:
authenticationType
- The authentication type for the user. This parameter is required. You must specify USERPOOL.- Returns:
this
-
userName
Sets the value ofCfnUserProps.getUserName()
- Parameters:
userName
- The email address of the user. This parameter is required. 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.- Returns:
this
-
firstName
Sets the value ofCfnUserProps.getFirstName()
- Parameters:
firstName
- The first name, or given name, of the user.- Returns:
this
-
lastName
Sets the value ofCfnUserProps.getLastName()
- Parameters:
lastName
- The last name, or surname, of the user.- Returns:
this
-
messageAction
Sets the value ofCfnUserProps.getMessageAction()
- 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. 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.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUserProps>
- Returns:
- a new instance of
CfnUserProps
- Throws:
NullPointerException
- if any required attribute was not provided
-