software.amazon.awscdk.services.appstream

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.652Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserProps.Builder A builder for CfnUserProps
static class	CfnUserProps.Jsii$Proxy An implementation for CfnUserProps

Method Summary

Modifier and Type	Method and Description
static CfnUserProps.Builder	builder()
String	getAuthenticationType() The authentication type for the user.
default String	getFirstName() The first name, or given name, of the user.
default String	getLastName() The last name, or surname, of the user.
default String	getMessageAction() The action to take for the welcome email that is sent to a user after the user is created in the user pool.
String	getUserName() The email address of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthenticationType

@Stability(value=Stable)
 @NotNull
String getAuthenticationType()

The authentication type for the user.

You must specify USERPOOL.

getUserName

@Stability(value=Stable)
 @NotNull
String 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.

getFirstName

@Stability(value=Stable)
 @Nullable
default String getFirstName()

The first name, or given name, of the user.

getLastName

@Stability(value=Stable)
 @Nullable
default String getLastName()

The last name, or surname, of the user.

getMessageAction

@Stability(value=Stable)
 @Nullable
default String 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.

builder

@Stability(value=Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps