Interface CreateUserProfileRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateUserProfileRequest.Builder,
,CreateUserProfileRequest> SageMakerRequest.Builder
,SdkBuilder<CreateUserProfileRequest.Builder,
,CreateUserProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateUserProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the associated Domain.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.singleSignOnUserIdentifier
(String singleSignOnUserIdentifier) A specifier for the type of value specified in SingleSignOnUserValue.singleSignOnUserValue
(String singleSignOnUserValue) The username of the associated Amazon Web Services Single Sign-On User for this UserProfile.tags
(Collection<Tag> tags) Each tag consists of a key and an optional value.tags
(Consumer<Tag.Builder>... tags) Each tag consists of a key and an optional value.Each tag consists of a key and an optional value.userProfileName
(String userProfileName) A name for the UserProfile.default CreateUserProfileRequest.Builder
userSettings
(Consumer<UserSettings.Builder> userSettings) A collection of settings.userSettings
(UserSettings userSettings) A collection of settings.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
A collection of settings.
This is a convenience method that creates an instance of theUserSettings.Builder
avoiding the need to create one manually viaUserSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserSettings(UserSettings)
.- Parameters:
userSettings
- a consumer that will call methods onUserSettings.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 interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateUserProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-