Interface CreateUserRequest.Builder

All Superinterfaces:
AppStreamRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>, SdkBuilder<CreateUserRequest.Builder,CreateUserRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateUserRequest

public static interface CreateUserRequest.Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
  • Method Details

    • userName

      CreateUserRequest.Builder userName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • messageAction

      CreateUserRequest.Builder messageAction(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • messageAction

      CreateUserRequest.Builder messageAction(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • firstName

      CreateUserRequest.Builder firstName(String firstName)

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

      Parameters:
      firstName - The first name, or given name, of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastName

      CreateUserRequest.Builder lastName(String lastName)

      The last name, or surname, of the user.

      Parameters:
      lastName - The last name, or surname, of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • authenticationType

      CreateUserRequest.Builder authenticationType(String authenticationType)

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

      Parameters:
      authenticationType - The authentication type for the user. You must specify USERPOOL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • authenticationType

      CreateUserRequest.Builder authenticationType(AuthenticationType authenticationType)

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

      Parameters:
      authenticationType - The authentication type for the user. You must specify USERPOOL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.