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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.