Class CfnDomain.UserSettingsProperty.Builder
java.lang.Object
software.amazon.awscdk.services.sagemaker.CfnDomain.UserSettingsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomain.UserSettingsProperty>
- Enclosing interface:
CfnDomain.UserSettingsProperty
@Stability(Stable)
public static final class CfnDomain.UserSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain.UserSettingsProperty>
A builder for
CfnDomain.UserSettingsProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.codeEditorAppSettings
(IResolvable codeEditorAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
codeEditorAppSettings
(CfnDomain.CodeEditorAppSettingsProperty codeEditorAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
customFileSystemConfigs
(List<? extends Object> customFileSystemConfigs) Sets the value ofCfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
customFileSystemConfigs
(IResolvable customFileSystemConfigs) Sets the value ofCfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
customPosixUserConfig
(IResolvable customPosixUserConfig) Sets the value ofCfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
customPosixUserConfig
(CfnDomain.CustomPosixUserConfigProperty customPosixUserConfig) Sets the value ofCfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
defaultLandingUri
(String defaultLandingUri) Sets the value ofCfnDomain.UserSettingsProperty.getDefaultLandingUri()
executionRole
(String executionRole) Sets the value ofCfnDomain.UserSettingsProperty.getExecutionRole()
jupyterLabAppSettings
(IResolvable jupyterLabAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
jupyterLabAppSettings
(CfnDomain.JupyterLabAppSettingsProperty jupyterLabAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
jupyterServerAppSettings
(IResolvable jupyterServerAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
jupyterServerAppSettings
(CfnDomain.JupyterServerAppSettingsProperty jupyterServerAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
kernelGatewayAppSettings
(IResolvable kernelGatewayAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
kernelGatewayAppSettings
(CfnDomain.KernelGatewayAppSettingsProperty kernelGatewayAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
rSessionAppSettings
(IResolvable rSessionAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRSessionAppSettings()
rSessionAppSettings
(CfnDomain.RSessionAppSettingsProperty rSessionAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRSessionAppSettings()
rStudioServerProAppSettings
(IResolvable rStudioServerProAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
rStudioServerProAppSettings
(CfnDomain.RStudioServerProAppSettingsProperty rStudioServerProAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
securityGroups
(List<String> securityGroups) Sets the value ofCfnDomain.UserSettingsProperty.getSecurityGroups()
sharingSettings
(IResolvable sharingSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSharingSettings()
sharingSettings
(CfnDomain.SharingSettingsProperty sharingSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSharingSettings()
spaceStorageSettings
(IResolvable spaceStorageSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSpaceStorageSettings()
spaceStorageSettings
(CfnDomain.DefaultSpaceStorageSettingsProperty spaceStorageSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSpaceStorageSettings()
studioWebPortal
(String studioWebPortal) Sets the value ofCfnDomain.UserSettingsProperty.getStudioWebPortal()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
executionRole
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder executionRole(String executionRole) Sets the value ofCfnDomain.UserSettingsProperty.getExecutionRole()
- Parameters:
executionRole
- The execution role for the user. This parameter is required.- Returns:
this
-
codeEditorAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder codeEditorAppSettings(IResolvable codeEditorAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
- Parameters:
codeEditorAppSettings
- The Code Editor application settings.- Returns:
this
-
codeEditorAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder codeEditorAppSettings(CfnDomain.CodeEditorAppSettingsProperty codeEditorAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
- Parameters:
codeEditorAppSettings
- The Code Editor application settings.- Returns:
this
-
customFileSystemConfigs
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder customFileSystemConfigs(IResolvable customFileSystemConfigs) Sets the value ofCfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
- Parameters:
customFileSystemConfigs
- The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.- Returns:
this
-
customFileSystemConfigs
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder customFileSystemConfigs(List<? extends Object> customFileSystemConfigs) Sets the value ofCfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
- Parameters:
customFileSystemConfigs
- The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.- Returns:
this
-
customPosixUserConfig
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder customPosixUserConfig(IResolvable customPosixUserConfig) Sets the value ofCfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
- Parameters:
customPosixUserConfig
- Details about the POSIX identity that is used for file system operations.- Returns:
this
-
customPosixUserConfig
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder customPosixUserConfig(CfnDomain.CustomPosixUserConfigProperty customPosixUserConfig) Sets the value ofCfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
- Parameters:
customPosixUserConfig
- Details about the POSIX identity that is used for file system operations.- Returns:
this
-
defaultLandingUri
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder defaultLandingUri(String defaultLandingUri) Sets the value ofCfnDomain.UserSettingsProperty.getDefaultLandingUri()
- Parameters:
defaultLandingUri
- The default experience that the user is directed to when accessing the domain. The supported values are:.studio::
: Indicates that Studio is the default experience. This value can only be passed ifStudioWebPortal
is set toENABLED
.app:JupyterServer:
: Indicates that Studio Classic is the default experience.
- Returns:
this
-
jupyterLabAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder jupyterLabAppSettings(IResolvable jupyterLabAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
- Parameters:
jupyterLabAppSettings
- The settings for the JupyterLab application.- Returns:
this
-
jupyterLabAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder jupyterLabAppSettings(CfnDomain.JupyterLabAppSettingsProperty jupyterLabAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
- Parameters:
jupyterLabAppSettings
- The settings for the JupyterLab application.- Returns:
this
-
jupyterServerAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder jupyterServerAppSettings(IResolvable jupyterServerAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
- Parameters:
jupyterServerAppSettings
- The Jupyter server's app settings.- Returns:
this
-
jupyterServerAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder jupyterServerAppSettings(CfnDomain.JupyterServerAppSettingsProperty jupyterServerAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
- Parameters:
jupyterServerAppSettings
- The Jupyter server's app settings.- Returns:
this
-
kernelGatewayAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder kernelGatewayAppSettings(IResolvable kernelGatewayAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
- Parameters:
kernelGatewayAppSettings
- The kernel gateway app settings.- Returns:
this
-
kernelGatewayAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder kernelGatewayAppSettings(CfnDomain.KernelGatewayAppSettingsProperty kernelGatewayAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
- Parameters:
kernelGatewayAppSettings
- The kernel gateway app settings.- Returns:
this
-
rSessionAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder rSessionAppSettings(IResolvable rSessionAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRSessionAppSettings()
- Parameters:
rSessionAppSettings
- A collection of settings that configure theRSessionGateway
app.- Returns:
this
-
rSessionAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder rSessionAppSettings(CfnDomain.RSessionAppSettingsProperty rSessionAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRSessionAppSettings()
- Parameters:
rSessionAppSettings
- A collection of settings that configure theRSessionGateway
app.- Returns:
this
-
rStudioServerProAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder rStudioServerProAppSettings(IResolvable rStudioServerProAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
- Parameters:
rStudioServerProAppSettings
- A collection of settings that configure user interaction with theRStudioServerPro
app.- Returns:
this
-
rStudioServerProAppSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder rStudioServerProAppSettings(CfnDomain.RStudioServerProAppSettingsProperty rStudioServerProAppSettings) Sets the value ofCfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
- Parameters:
rStudioServerProAppSettings
- A collection of settings that configure user interaction with theRStudioServerPro
app.- Returns:
this
-
securityGroups
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder securityGroups(List<String> securityGroups) Sets the value ofCfnDomain.UserSettingsProperty.getSecurityGroups()
- Parameters:
securityGroups
- The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. Optional when theCreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
for the domain.Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
- Returns:
this
-
sharingSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder sharingSettings(IResolvable sharingSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSharingSettings()
- Parameters:
sharingSettings
- Specifies options for sharing Amazon SageMaker Studio notebooks.- Returns:
this
-
sharingSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder sharingSettings(CfnDomain.SharingSettingsProperty sharingSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSharingSettings()
- Parameters:
sharingSettings
- Specifies options for sharing Amazon SageMaker Studio notebooks.- Returns:
this
-
spaceStorageSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder spaceStorageSettings(IResolvable spaceStorageSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSpaceStorageSettings()
- Parameters:
spaceStorageSettings
- The storage settings for a private space.- Returns:
this
-
spaceStorageSettings
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder spaceStorageSettings(CfnDomain.DefaultSpaceStorageSettingsProperty spaceStorageSettings) Sets the value ofCfnDomain.UserSettingsProperty.getSpaceStorageSettings()
- Parameters:
spaceStorageSettings
- The storage settings for a private space.- Returns:
this
-
studioWebPortal
@Stability(Stable) public CfnDomain.UserSettingsProperty.Builder studioWebPortal(String studioWebPortal) Sets the value ofCfnDomain.UserSettingsProperty.getStudioWebPortal()
- Parameters:
studioWebPortal
- Whether the user can access Studio. If this value is set toDISABLED
, the user cannot access Studio, even if that is the default experience for the domain.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDomain.UserSettingsProperty>
- Returns:
- a new instance of
CfnDomain.UserSettingsProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-