Package software.amazon.awssdk.services.appstream.model

Class CreateUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.CreateUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends AppStreamRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationType	authenticationType()	The authentication type for the user.
String	authenticationTypeAsString()	The authentication type for the user.
static CreateUserRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	The first name, or given name, of the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastName()	The last name, or surname, of the user.
MessageAction	messageAction()	The action to take for the welcome email that is sent to a user after the user is created in the user pool.
String	messageActionAsString()	The action to take for the welcome email that is sent to a user after the user is created in the user pool.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
CreateUserRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The email address of the user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userName

public final String 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.

Returns:

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.

messageAction

public final MessageAction 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.

If the service returns an enum value that is not available in the current SDK version, messageAction will return MessageAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageActionAsString().

Returns:

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:

MessageAction

messageActionAsString

public final String messageActionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, messageAction will return MessageAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageActionAsString().

Returns:

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:

MessageAction

firstName

public final String firstName()

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

Returns:

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

lastName

public final String lastName()

The last name, or surname, of the user.

Returns:

The last name, or surname, of the user.

authenticationType

public final AuthenticationType authenticationType()

The authentication type for the user. You must specify USERPOOL.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type for the user. You must specify USERPOOL.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

The authentication type for the user. You must specify USERPOOL.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type for the user. You must specify USERPOOL.

See Also:

AuthenticationType

toBuilder

public CreateUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class AppStreamRequest

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo