Package software.amazon.awssdk.services.sagemaker.model

Interface CreateUserProfileRequest.Builder

    • Method Detail

      • domainId

        CreateUserProfileRequest.Builder domainId​(String 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

        CreateUserProfileRequest.Builder tags​(Collection<Tag> 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

        CreateUserProfileRequest.Builder tags​(Tag... 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

        CreateUserProfileRequest.Builder tags​(Consumer<Tag.Builder>... 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).

        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:
        #tags(java.util.Collection)

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