Package software.amazon.awscdk.services.sagemaker

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomain.UserSettingsProperty	build()	Builds the configured instance.
CfnDomain.UserSettingsProperty.Builder	codeEditorAppSettings(IResolvable codeEditorAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
CfnDomain.UserSettingsProperty.Builder	codeEditorAppSettings(CfnDomain.CodeEditorAppSettingsProperty codeEditorAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getCodeEditorAppSettings()
CfnDomain.UserSettingsProperty.Builder	customFileSystemConfigs(List<? extends Object> customFileSystemConfigs)	Sets the value of CfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
CfnDomain.UserSettingsProperty.Builder	customFileSystemConfigs(IResolvable customFileSystemConfigs)	Sets the value of CfnDomain.UserSettingsProperty.getCustomFileSystemConfigs()
CfnDomain.UserSettingsProperty.Builder	customPosixUserConfig(IResolvable customPosixUserConfig)	Sets the value of CfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
CfnDomain.UserSettingsProperty.Builder	customPosixUserConfig(CfnDomain.CustomPosixUserConfigProperty customPosixUserConfig)	Sets the value of CfnDomain.UserSettingsProperty.getCustomPosixUserConfig()
CfnDomain.UserSettingsProperty.Builder	defaultLandingUri(String defaultLandingUri)	Sets the value of CfnDomain.UserSettingsProperty.getDefaultLandingUri()
CfnDomain.UserSettingsProperty.Builder	executionRole(String executionRole)	Sets the value of CfnDomain.UserSettingsProperty.getExecutionRole()
CfnDomain.UserSettingsProperty.Builder	jupyterLabAppSettings(IResolvable jupyterLabAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
CfnDomain.UserSettingsProperty.Builder	jupyterLabAppSettings(CfnDomain.JupyterLabAppSettingsProperty jupyterLabAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getJupyterLabAppSettings()
CfnDomain.UserSettingsProperty.Builder	jupyterServerAppSettings(IResolvable jupyterServerAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
CfnDomain.UserSettingsProperty.Builder	jupyterServerAppSettings(CfnDomain.JupyterServerAppSettingsProperty jupyterServerAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getJupyterServerAppSettings()
CfnDomain.UserSettingsProperty.Builder	kernelGatewayAppSettings(IResolvable kernelGatewayAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
CfnDomain.UserSettingsProperty.Builder	kernelGatewayAppSettings(CfnDomain.KernelGatewayAppSettingsProperty kernelGatewayAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()
CfnDomain.UserSettingsProperty.Builder	rSessionAppSettings(IResolvable rSessionAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getRSessionAppSettings()
CfnDomain.UserSettingsProperty.Builder	rSessionAppSettings(CfnDomain.RSessionAppSettingsProperty rSessionAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getRSessionAppSettings()
CfnDomain.UserSettingsProperty.Builder	rStudioServerProAppSettings(IResolvable rStudioServerProAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
CfnDomain.UserSettingsProperty.Builder	rStudioServerProAppSettings(CfnDomain.RStudioServerProAppSettingsProperty rStudioServerProAppSettings)	Sets the value of CfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()
CfnDomain.UserSettingsProperty.Builder	securityGroups(List<String> securityGroups)	Sets the value of CfnDomain.UserSettingsProperty.getSecurityGroups()
CfnDomain.UserSettingsProperty.Builder	sharingSettings(IResolvable sharingSettings)	Sets the value of CfnDomain.UserSettingsProperty.getSharingSettings()
CfnDomain.UserSettingsProperty.Builder	sharingSettings(CfnDomain.SharingSettingsProperty sharingSettings)	Sets the value of CfnDomain.UserSettingsProperty.getSharingSettings()
CfnDomain.UserSettingsProperty.Builder	spaceStorageSettings(IResolvable spaceStorageSettings)	Sets the value of CfnDomain.UserSettingsProperty.getSpaceStorageSettings()
CfnDomain.UserSettingsProperty.Builder	spaceStorageSettings(CfnDomain.DefaultSpaceStorageSettingsProperty spaceStorageSettings)	Sets the value of CfnDomain.UserSettingsProperty.getSpaceStorageSettings()
CfnDomain.UserSettingsProperty.Builder	studioWebPortal(String studioWebPortal)	Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortal()
CfnDomain.UserSettingsProperty.Builder	studioWebPortalSettings(IResolvable studioWebPortalSettings)	Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortalSettings()
CfnDomain.UserSettingsProperty.Builder	studioWebPortalSettings(CfnDomain.StudioWebPortalSettingsProperty studioWebPortalSettings)	Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortalSettings()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

executionRole

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder executionRole(String executionRole)

Sets the value of CfnDomain.UserSettingsProperty.getExecutionRole()

Parameters:

executionRole - The execution role for the user. This parameter is required. SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

Returns:

this

codeEditorAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder codeEditorAppSettings(IResolvable codeEditorAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getCodeEditorAppSettings()

Parameters:

codeEditorAppSettings - The Code Editor application settings. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

codeEditorAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder codeEditorAppSettings(CfnDomain.CodeEditorAppSettingsProperty codeEditorAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getCodeEditorAppSettings()

Parameters:

codeEditorAppSettings - The Code Editor application settings. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

customFileSystemConfigs

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder customFileSystemConfigs(IResolvable customFileSystemConfigs)

Sets the value of CfnDomain.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 AI Studio.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

customFileSystemConfigs

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder customFileSystemConfigs(List<? extends Object> customFileSystemConfigs)

Sets the value of CfnDomain.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 AI Studio.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

customPosixUserConfig

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder customPosixUserConfig(IResolvable customPosixUserConfig)

Sets the value of CfnDomain.UserSettingsProperty.getCustomPosixUserConfig()

Parameters:

customPosixUserConfig - Details about the POSIX identity that is used for file system operations. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

customPosixUserConfig

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder customPosixUserConfig(CfnDomain.CustomPosixUserConfigProperty customPosixUserConfig)

Sets the value of CfnDomain.UserSettingsProperty.getCustomPosixUserConfig()

Parameters:

customPosixUserConfig - Details about the POSIX identity that is used for file system operations. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

defaultLandingUri

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder defaultLandingUri(String defaultLandingUri)

Sets the value of CfnDomain.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 if StudioWebPortal is set to ENABLED .
• 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 of CfnDomain.UserSettingsProperty.getJupyterLabAppSettings()

Parameters:

jupyterLabAppSettings - The settings for the JupyterLab application. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

jupyterLabAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder jupyterLabAppSettings(CfnDomain.JupyterLabAppSettingsProperty jupyterLabAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getJupyterLabAppSettings()

Parameters:

jupyterLabAppSettings - The settings for the JupyterLab application. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

jupyterServerAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder jupyterServerAppSettings(IResolvable jupyterServerAppSettings)

Sets the value of CfnDomain.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 of CfnDomain.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 of CfnDomain.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 of CfnDomain.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

rSessionAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder rSessionAppSettings(IResolvable rSessionAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getRSessionAppSettings()

Parameters:

rSessionAppSettings - A collection of settings that configure the RSessionGateway app.

Returns:

this

rSessionAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder rSessionAppSettings(CfnDomain.RSessionAppSettingsProperty rSessionAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getRSessionAppSettings()

Parameters:

rSessionAppSettings - A collection of settings that configure the RSessionGateway app.

Returns:

this

rStudioServerProAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder rStudioServerProAppSettings(IResolvable rStudioServerProAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

rStudioServerProAppSettings - A collection of settings that configure user interaction with the RStudioServerPro app.

Returns:

this

rStudioServerProAppSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder rStudioServerProAppSettings(CfnDomain.RStudioServerProAppSettingsProperty rStudioServerProAppSettings)

Sets the value of CfnDomain.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

rStudioServerProAppSettings - A collection of settings that configure user interaction with the RStudioServerPro app.

Returns:

this

securityGroups

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder securityGroups(List<String> securityGroups)

Sets the value of CfnDomain.UserSettingsProperty.getSecurityGroups()

Parameters:

securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

sharingSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder sharingSettings(IResolvable sharingSettings)

Sets the value of CfnDomain.UserSettingsProperty.getSharingSettings()

Parameters:

sharingSettings - Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Returns:

this

sharingSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder sharingSettings(CfnDomain.SharingSettingsProperty sharingSettings)

Sets the value of CfnDomain.UserSettingsProperty.getSharingSettings()

Parameters:

sharingSettings - Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Returns:

this

spaceStorageSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder spaceStorageSettings(IResolvable spaceStorageSettings)

Sets the value of CfnDomain.UserSettingsProperty.getSpaceStorageSettings()

Parameters:

spaceStorageSettings - The storage settings for a space. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

spaceStorageSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder spaceStorageSettings(CfnDomain.DefaultSpaceStorageSettingsProperty spaceStorageSettings)

Sets the value of CfnDomain.UserSettingsProperty.getSpaceStorageSettings()

Parameters:

spaceStorageSettings - The storage settings for a space. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

Returns:

this

studioWebPortal

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder studioWebPortal(String studioWebPortal)

Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortal()

Parameters:

studioWebPortal - Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

Returns:

this

studioWebPortalSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder studioWebPortalSettings(IResolvable studioWebPortalSettings)

Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortalSettings()

Parameters:

studioWebPortalSettings - Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Returns:

this

studioWebPortalSettings

@Stability(Stable)
public CfnDomain.UserSettingsProperty.Builder studioWebPortalSettings(CfnDomain.StudioWebPortalSettingsProperty studioWebPortalSettings)

Sets the value of CfnDomain.UserSettingsProperty.getStudioWebPortalSettings()

Parameters:

studioWebPortalSettings - Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Returns:

this

build

@Stability(Stable)
public CfnDomain.UserSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain.UserSettingsProperty>

Returns:

a new instance of CfnDomain.UserSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided