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(value="software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends AppStreamRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method and 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)
String	firstName() The first name, or given name, of the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
CreateUserRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

userName

public String userName()

The email address of the user.

Returns:

The email address of the user.

messageAction

public 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 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 String firstName()

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

Returns:

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

lastName

public String lastName()

The last name, or surname, of the user.

Returns:

The last name, or surname, of the user.

authenticationType

public 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.