Interface CreateUserProfileRequest.Builder

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

public static interface CreateUserProfileRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateUserProfileRequest.Builder,CreateUserProfileRequest>
  • Method Details

    • domainId

      The ID of the associated Domain.

      Parameters:
      domainId - The ID of the associated Domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • userProfileName

      CreateUserProfileRequest.Builder userProfileName(String userProfileName)

      A name for the UserProfile. This value is not case sensitive.

      Parameters:
      userProfileName - A name for the UserProfile. This value is not case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • singleSignOnUserIdentifier

      CreateUserProfileRequest.Builder singleSignOnUserIdentifier(String singleSignOnUserIdentifier)

      A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

      Parameters:
      singleSignOnUserIdentifier - A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • singleSignOnUserValue

      CreateUserProfileRequest.Builder singleSignOnUserValue(String singleSignOnUserValue)

      The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

      Parameters:
      singleSignOnUserValue - The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

      Parameters:
      tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

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

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

      Parameters:
      tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

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

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

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

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

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

      CreateUserProfileRequest.Builder userSettings(UserSettings userSettings)

      A collection of settings.

      Parameters:
      userSettings - A collection of settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • userSettings

      default CreateUserProfileRequest.Builder userSettings(Consumer<UserSettings.Builder> userSettings)

      A collection of settings.

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

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

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

      CreateUserProfileRequest.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.