Class CfnUserProfileProps.Builder
java.lang.Object
software.amazon.awscdk.services.sagemaker.CfnUserProfileProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserProfileProps>
- Enclosing interface:
CfnUserProfileProps
@Stability(Stable)
public static final class CfnUserProfileProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserProfileProps>
A builder for
CfnUserProfileProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofCfnUserProfileProps.getDomainId()
singleSignOnUserIdentifier
(String singleSignOnUserIdentifier) Sets the value ofCfnUserProfileProps.getSingleSignOnUserIdentifier()
singleSignOnUserValue
(String singleSignOnUserValue) Sets the value ofCfnUserProfileProps.getSingleSignOnUserValue()
Sets the value ofCfnUserProfileProps.getTags()
userProfileName
(String userProfileName) Sets the value ofCfnUserProfileProps.getUserProfileName()
userSettings
(IResolvable userSettings) Sets the value ofCfnUserProfileProps.getUserSettings()
userSettings
(CfnUserProfile.UserSettingsProperty userSettings) Sets the value ofCfnUserProfileProps.getUserSettings()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
domainId
Sets the value ofCfnUserProfileProps.getDomainId()
- Parameters:
domainId
- The domain ID. This parameter is required.- Returns:
this
-
userProfileName
Sets the value ofCfnUserProfileProps.getUserProfileName()
- Parameters:
userProfileName
- The user profile name. This parameter is required.- Returns:
this
-
singleSignOnUserIdentifier
@Stability(Stable) public CfnUserProfileProps.Builder singleSignOnUserIdentifier(String singleSignOnUserIdentifier) Sets the value ofCfnUserProfileProps.getSingleSignOnUserIdentifier()
- 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:
this
-
singleSignOnUserValue
@Stability(Stable) public CfnUserProfileProps.Builder singleSignOnUserValue(String singleSignOnUserValue) Sets the value ofCfnUserProfileProps.getSingleSignOnUserValue()
- Parameters:
singleSignOnUserValue
- The username of the associated AWS 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:
this
-
tags
Sets the value ofCfnUserProfileProps.getTags()
- Parameters:
tags
- An array of key-value pairs to apply to this resource. Tags that you specify for the User Profile are also added to all apps that the User Profile launches.For more information, see Tag .
- Returns:
this
-
userSettings
Sets the value ofCfnUserProfileProps.getUserSettings()
- Parameters:
userSettings
- A collection of settings that apply to users of Amazon SageMaker Studio.- Returns:
this
-
userSettings
@Stability(Stable) public CfnUserProfileProps.Builder userSettings(CfnUserProfile.UserSettingsProperty userSettings) Sets the value ofCfnUserProfileProps.getUserSettings()
- Parameters:
userSettings
- A collection of settings that apply to users of Amazon SageMaker Studio.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUserProfileProps>
- Returns:
- a new instance of
CfnUserProfileProps
- Throws:
NullPointerException
- if any required attribute was not provided
-