Package software.amazon.awssdk.services.identitystore.model

Interface CreateUserRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>, IdentitystoreRequest.Builder, SdkBuilder<CreateUserRequest.Builder,CreateUserRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateUserRequest
public static interface CreateUserRequest.Builder extends IdentitystoreRequest.Builder, SdkPojo, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

  • Method Details

    • identityStoreId

      CreateUserRequest.Builder identityStoreId(String identityStoreId)

      The globally unique identifier for the identity store.

      Parameters:
      identityStoreId - The globally unique identifier for the identity store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userName

      CreateUserRequest.Builder userName(String userName)

      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

      Parameters:
      userName - A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateUserRequest.Builder name(Name name)

      An object containing the name of the user.

      Parameters:
      name - An object containing the name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      default CreateUserRequest.Builder name(Consumer<Name.Builder> name)

      An object containing the name of the user.

      This is a convenience method that creates an instance of the Name.Builder avoiding the need to create one manually via Name.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to name(Name).

      Parameters:
      name - a consumer that will call methods on Name.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • displayName

      CreateUserRequest.Builder displayName(String displayName)

      A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

      Parameters:
      displayName - A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nickName

      CreateUserRequest.Builder nickName(String nickName)

      A string containing an alternate name for the user.

      Parameters:
      nickName - A string containing an alternate name for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileUrl

      CreateUserRequest.Builder profileUrl(String profileUrl)

      A string containing a URL that might be associated with the user.

      Parameters:
      profileUrl - A string containing a URL that might be associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      CreateUserRequest.Builder emails(Collection<Email> emails)

      A list of Email objects containing email addresses associated with the user.

      Parameters:
      emails - A list of Email objects containing email addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      CreateUserRequest.Builder emails(Email... emails)

      A list of Email objects containing email addresses associated with the user.

      Parameters:
      emails - A list of Email objects containing email addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emails

      CreateUserRequest.Builder emails(Consumer<Email.Builder>... emails)

      A list of Email objects containing email addresses associated with the user.

      This is a convenience method that creates an instance of the Email.Builder avoiding the need to create one manually via Email.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emails(List<Email>).

      Parameters:
      emails - a consumer that will call methods on Email.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addresses

      CreateUserRequest.Builder addresses(Collection<Address> addresses)

      A list of Address objects containing addresses associated with the user.

      Parameters:
      addresses - A list of Address objects containing addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addresses

      CreateUserRequest.Builder addresses(Address... addresses)

      A list of Address objects containing addresses associated with the user.

      Parameters:
      addresses - A list of Address objects containing addresses associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addresses

      CreateUserRequest.Builder addresses(Consumer<Address.Builder>... addresses)

      A list of Address objects containing addresses associated with the user.

      This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to addresses(List<Address>).

      Parameters:
      addresses - a consumer that will call methods on Address.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumbers

      CreateUserRequest.Builder phoneNumbers(Collection<PhoneNumber> phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      Parameters:
      phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumbers

      CreateUserRequest.Builder phoneNumbers(PhoneNumber... phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      Parameters:
      phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • phoneNumbers

      CreateUserRequest.Builder phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers)

      A list of PhoneNumber objects containing phone numbers associated with the user.

      This is a convenience method that creates an instance of the PhoneNumber.Builder avoiding the need to create one manually via PhoneNumber.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to phoneNumbers(List<PhoneNumber>).

      Parameters:
      phoneNumbers - a consumer that will call methods on PhoneNumber.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userType

      CreateUserRequest.Builder userType(String userType)

      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

      Parameters:
      userType - A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      CreateUserRequest.Builder title(String title)

      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

      Parameters:
      title - A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredLanguage

      CreateUserRequest.Builder preferredLanguage(String preferredLanguage)

      A string containing the preferred language of the user. For example, "American English" or "en-us."

      Parameters:
      preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      CreateUserRequest.Builder locale(String locale)

      A string containing the geographical region or location of the user.

      Parameters:
      locale - A string containing the geographical region or location of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      CreateUserRequest.Builder timezone(String timezone)

      A string containing the time zone of the user.

      Parameters:
      timezone - A string containing the time zone of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • 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

      CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.