Package software.amazon.awscdk.services.sagemaker

Class CfnUserProfile.UserSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnUserProfile.UserSettingsProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnUserProfile.UserSettingsProperty

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

A builder for CfnUserProfile.UserSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

codeEditorAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getCodeEditorAppSettings()

Parameters:

codeEditorAppSettings - The Code Editor application settings.

Returns:

this

codeEditorAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getCodeEditorAppSettings()

Parameters:

codeEditorAppSettings - The Code Editor application settings.

Returns:

this

customFileSystemConfigs

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

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

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

Sets the value of CfnUserProfile.UserSettingsProperty.getCustomPosixUserConfig()

Parameters:

customPosixUserConfig - Details about the POSIX identity that is used for file system operations.

Returns:

this

customPosixUserConfig

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

Sets the value of CfnUserProfile.UserSettingsProperty.getCustomPosixUserConfig()

Parameters:

customPosixUserConfig - Details about the POSIX identity that is used for file system operations.

Returns:

this

defaultLandingUri

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

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

Sets the value of CfnUserProfile.UserSettingsProperty.getExecutionRole()

Parameters:

executionRole - The execution role for the user.

Returns:

this

jupyterLabAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getJupyterLabAppSettings()

Parameters:

jupyterLabAppSettings - The settings for the JupyterLab application.

Returns:

this

jupyterLabAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getJupyterLabAppSettings()

Parameters:

jupyterLabAppSettings - The settings for the JupyterLab application.

Returns:

this

jupyterServerAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

jupyterServerAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getJupyterServerAppSettings()

Parameters:

jupyterServerAppSettings - The Jupyter server's app settings.

Returns:

this

kernelGatewayAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

kernelGatewayAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getKernelGatewayAppSettings()

Parameters:

kernelGatewayAppSettings - The kernel gateway app settings.

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

rStudioServerProAppSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getRStudioServerProAppSettings()

Parameters:

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

Returns:

this

securityGroups

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

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

Sets the value of CfnUserProfile.UserSettingsProperty.getSharingSettings()

Parameters:

sharingSettings - Specifies options for sharing Amazon SageMaker Studio notebooks.

Returns:

this

sharingSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getSharingSettings()

Parameters:

sharingSettings - Specifies options for sharing Amazon SageMaker Studio notebooks.

Returns:

this

spaceStorageSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getSpaceStorageSettings()

Parameters:

spaceStorageSettings - The storage settings for a space.

Returns:

this

spaceStorageSettings

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

Sets the value of CfnUserProfile.UserSettingsProperty.getSpaceStorageSettings()

Parameters:

spaceStorageSettings - The storage settings for a space.

Returns:

this

studioWebPortal

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

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

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

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUserProfile.UserSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided