Package software.amazon.awscdk.mixins.preview.services.sagemaker.mixins

Class CfnUserProfilePropsMixin.UserSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnUserProfilePropsMixin.UserSettingsProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnUserProfilePropsMixin.UserSettingsProperty

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

A builder for CfnUserProfilePropsMixin.UserSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

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

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

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

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

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

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

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

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

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

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

jupyterServerAppSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

kernelGatewayAppSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

kernelGatewayAppSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

securityGroups

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

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getSharingSettings()

Parameters:

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

Returns:

this

sharingSettings

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

Sets the value of CfnUserProfilePropsMixin.UserSettingsProperty.getSharingSettings()

Parameters:

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

Returns:

this

spaceStorageSettings

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

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

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

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

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

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUserProfilePropsMixin.UserSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided