Interface CfnUserProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUserProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:11.338Z")
@Stability(Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable
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 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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserProps
static final class
An implementation forCfnUserProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnUserProps.Builder
builder()
The authentication type for the user.default String
The first name, or given name, of the user.default String
The last name, or surname, of the user.default String
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.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthenticationType
The authentication type for the user.You must specify USERPOOL.
- See Also:
-
getUserName
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.
- See Also:
-
getFirstName
The first name, or given name, of the user.- See Also:
-
getLastName
The last name, or surname, of the user.- See Also:
-
getMessageAction
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.
- See Also:
-
builder
- Returns:
- a
CfnUserProps.Builder
ofCfnUserProps
-