Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnDomainPropsMixin.UserSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnDomainPropsMixin.UserSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainPropsMixin.UserSettingsProperty>

Enclosing interface:

CfnDomainPropsMixin.UserSettingsProperty

@Stability(Stable)
public static final class CfnDomainPropsMixin.UserSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomainPropsMixin.UserSettingsProperty>

A builder for CfnDomainPropsMixin.UserSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

autoMountHomeEfs

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder autoMountHomeEfs(String autoMountHomeEfs)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getAutoMountHomeEfs()

Parameters:

autoMountHomeEfs - Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

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 CfnDomainPropsMixin.UserSettingsProperty.Builder codeEditorAppSettings(IResolvable codeEditorAppSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder codeEditorAppSettings(CfnDomainPropsMixin.CodeEditorAppSettingsProperty codeEditorAppSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder customFileSystemConfigs(IResolvable customFileSystemConfigs)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder customFileSystemConfigs(List<? extends Object> customFileSystemConfigs)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder customPosixUserConfig(IResolvable customPosixUserConfig)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder customPosixUserConfig(CfnDomainPropsMixin.CustomPosixUserConfigProperty customPosixUserConfig)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder defaultLandingUri(String defaultLandingUri)

Sets the value of CfnDomainPropsMixin.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

executionRole

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getExecutionRole()

Parameters:

executionRole - The execution role for the user. 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

executionRole

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder executionRole(IRoleRef executionRole)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getExecutionRole()

Parameters:

executionRole - The execution role for the user. 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

jupyterLabAppSettings

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder jupyterLabAppSettings(IResolvable jupyterLabAppSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder jupyterLabAppSettings(CfnDomainPropsMixin.JupyterLabAppSettingsProperty jupyterLabAppSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder jupyterServerAppSettings(IResolvable jupyterServerAppSettings)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

jupyterServerAppSettings

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder jupyterServerAppSettings(CfnDomainPropsMixin.JupyterServerAppSettingsProperty jupyterServerAppSettings)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

kernelGatewayAppSettings

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder kernelGatewayAppSettings(IResolvable kernelGatewayAppSettings)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

kernelGatewayAppSettings

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder kernelGatewayAppSettings(CfnDomainPropsMixin.KernelGatewayAppSettingsProperty kernelGatewayAppSettings)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

rSessionAppSettings

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getRSessionAppSettings()

Parameters:

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

Returns:

this

rSessionAppSettings

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getRSessionAppSettings()

Parameters:

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

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

securityGroups

@Stability(Stable)
public CfnDomainPropsMixin.UserSettingsProperty.Builder securityGroups(List<? extends Object> securityGroups)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder sharingSettings(IResolvable sharingSettings)

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getSharingSettings()

Parameters:

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

Returns:

this

sharingSettings

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

Sets the value of CfnDomainPropsMixin.UserSettingsProperty.getSharingSettings()

Parameters:

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

Returns:

this

spaceStorageSettings

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

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder spaceStorageSettings(CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty spaceStorageSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder studioWebPortal(String studioWebPortal)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder studioWebPortalSettings(IResolvable studioWebPortalSettings)

Sets the value of CfnDomainPropsMixin.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 CfnDomainPropsMixin.UserSettingsProperty.Builder studioWebPortalSettings(CfnDomainPropsMixin.StudioWebPortalSettingsProperty studioWebPortalSettings)

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainPropsMixin.UserSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided