DomainDefaultUserSettings

data class DomainDefaultUserSettings(val autoMountHomeEfs: String? = null, val canvasAppSettings: DomainDefaultUserSettingsCanvasAppSettings? = null, val codeEditorAppSettings: DomainDefaultUserSettingsCodeEditorAppSettings? = null, val customFileSystemConfigs: List<DomainDefaultUserSettingsCustomFileSystemConfig>? = null, val customPosixUserConfig: DomainDefaultUserSettingsCustomPosixUserConfig? = null, val defaultLandingUri: String? = null, val executionRole: String, val jupyterLabAppSettings: DomainDefaultUserSettingsJupyterLabAppSettings? = null, val jupyterServerAppSettings: DomainDefaultUserSettingsJupyterServerAppSettings? = null, val kernelGatewayAppSettings: DomainDefaultUserSettingsKernelGatewayAppSettings? = null, val rSessionAppSettings: DomainDefaultUserSettingsRSessionAppSettings? = null, val rStudioServerProAppSettings: DomainDefaultUserSettingsRStudioServerProAppSettings? = null, val securityGroups: List<String>? = null, val sharingSettings: DomainDefaultUserSettingsSharingSettings? = null, val spaceStorageSettings: DomainDefaultUserSettingsSpaceStorageSettings? = null, val studioWebPortal: String? = null, val studioWebPortalSettings: DomainDefaultUserSettingsStudioWebPortalSettings? = null, val tensorBoardAppSettings: DomainDefaultUserSettingsTensorBoardAppSettings? = null)

Constructors

Link copied to clipboard
constructor(autoMountHomeEfs: String? = null, canvasAppSettings: DomainDefaultUserSettingsCanvasAppSettings? = null, codeEditorAppSettings: DomainDefaultUserSettingsCodeEditorAppSettings? = null, customFileSystemConfigs: List<DomainDefaultUserSettingsCustomFileSystemConfig>? = null, customPosixUserConfig: DomainDefaultUserSettingsCustomPosixUserConfig? = null, defaultLandingUri: String? = null, executionRole: String, jupyterLabAppSettings: DomainDefaultUserSettingsJupyterLabAppSettings? = null, jupyterServerAppSettings: DomainDefaultUserSettingsJupyterServerAppSettings? = null, kernelGatewayAppSettings: DomainDefaultUserSettingsKernelGatewayAppSettings? = null, rSessionAppSettings: DomainDefaultUserSettingsRSessionAppSettings? = null, rStudioServerProAppSettings: DomainDefaultUserSettingsRStudioServerProAppSettings? = null, securityGroups: List<String>? = null, sharingSettings: DomainDefaultUserSettingsSharingSettings? = null, spaceStorageSettings: DomainDefaultUserSettingsSpaceStorageSettings? = null, studioWebPortal: String? = null, studioWebPortalSettings: DomainDefaultUserSettingsStudioWebPortalSettings? = null, tensorBoardAppSettings: DomainDefaultUserSettingsTensorBoardAppSettings? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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. Valid values are: Enabled, Disabled, and DefaultAsDomain.

Link copied to clipboard

The Canvas app settings. See canvas_app_settings Block below.

Link copied to clipboard

The Code Editor application settings. See code_editor_app_settings Block below.

Link copied to clipboard

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio. See custom_file_system_config Block below.

Link copied to clipboard

Details about the POSIX identity that is used for file system operations. See custom_posix_user_config Block below.

Link copied to clipboard

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.

Link copied to clipboard

The execution role ARN for the user.

Link copied to clipboard

The settings for the JupyterLab application. See jupyter_lab_app_settings Block below.

Link copied to clipboard

The Jupyter server's app settings. See jupyter_server_app_settings Block below.

Link copied to clipboard

The kernel gateway app settings. See kernel_gateway_app_settings Block below.

Link copied to clipboard

The RSession app settings. See r_session_app_settings Block below.

Link copied to clipboard

A collection of settings that configure user interaction with the RStudioServerPro app. See r_studio_server_pro_app_settings Block below.

Link copied to clipboard
val securityGroups: List<String>? = null

A list of security group IDs that will be attached to the user.

Link copied to clipboard

The sharing settings. See sharing_settings Block below.

Link copied to clipboard

The storage settings for a private space. See space_storage_settings Block below.

Link copied to clipboard
val studioWebPortal: String? = null

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. Valid values are ENABLED and DISABLED.

Link copied to clipboard

The Studio Web Portal settings. See studio_web_portal_settings Block below.

Link copied to clipboard

The TensorBoard app settings. See tensor_board_app_settings Block below.