DomainDefaultUserSettings class
Constructors
-
DomainDefaultUserSettings({Input<
String?> ? autoMountHomeEfs, Input<DomainDefaultUserSettingsCanvasAppSettings?> ? canvasAppSettings, Input<DomainDefaultUserSettingsCodeEditorAppSettings?> ? codeEditorAppSettings, Input<List< ? customFileSystemConfigs, Input<DomainDefaultUserSettingsCustomFileSystemConfig> ?>DomainDefaultUserSettingsCustomPosixUserConfig?> ? customPosixUserConfig, Input<String?> ? defaultLandingUri, required Input<String> executionRole, Input<DomainDefaultUserSettingsJupyterLabAppSettings?> ? jupyterLabAppSettings, Input<DomainDefaultUserSettingsJupyterServerAppSettings?> ? jupyterServerAppSettings, Input<DomainDefaultUserSettingsKernelGatewayAppSettings?> ? kernelGatewayAppSettings, Input<DomainDefaultUserSettingsRSessionAppSettings?> ? rSessionAppSettings, Input<DomainDefaultUserSettingsRStudioServerProAppSettings?> ? rStudioServerProAppSettings, Input<List< ? securityGroups, Input<String> ?>DomainDefaultUserSettingsSharingSettings?> ? sharingSettings, Input<DomainDefaultUserSettingsSpaceStorageSettings?> ? spaceStorageSettings, Input<String?> ? studioWebPortal, Input<DomainDefaultUserSettingsStudioWebPortalSettings?> ? studioWebPortalSettings, Input<DomainDefaultUserSettingsTensorBoardAppSettings?> ? tensorBoardAppSettings}) -
Creates a new DomainDefaultUserSettings.
autoMountHomeEfsIndicates whether auto-mounting of an EFS volume is supported for the user profile. TheDefaultAsDomainvalue is only supported for user profiles. Do not use theDefaultAsDomainvalue when setting this parameter for a domain. Valid values are:Enabled,Disabled, andDefaultAsDomain.canvasAppSettingsThe Canvas app settings. SeecanvasAppSettingsBlock below.codeEditorAppSettingsThe Code Editor application settings. SeecodeEditorAppSettingsBlock below.customFileSystemConfigsThe settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio. SeecustomFileSystemConfigBlock below.customPosixUserConfigDetails about the POSIX identity that is used for file system operations. SeecustomPosixUserConfigBlock below.defaultLandingUriThe 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.executionRoleThe execution role ARN for the user.jupyterLabAppSettingsThe settings for the JupyterLab application. SeejupyterLabAppSettingsBlock below.jupyterServerAppSettingsThe Jupyter server's app settings. SeejupyterServerAppSettingsBlock below.kernelGatewayAppSettingsThe kernel gateway app settings. SeekernelGatewayAppSettingsBlock below.rSessionAppSettingsThe RSession app settings. SeerSessionAppSettingsBlock below.rStudioServerProAppSettingsA collection of settings that configure user interaction with the RStudioServerPro app. SeerStudioServerProAppSettingsBlock below.securityGroupsA list of security group IDs that will be attached to the user.sharingSettingsThe sharing settings. SeesharingSettingsBlock below.spaceStorageSettingsThe storage settings for a private space. SeespaceStorageSettingsBlock below.studioWebPortalWhether the user can access Studio. If this value is set toDISABLED, the user cannot access Studio, even if that is the default experience for the domain. Valid values areENABLEDandDISABLED.studioWebPortalSettingsThe Studio Web Portal settings. SeestudioWebPortalSettingsBlock below.tensorBoardAppSettingsThe TensorBoard app settings. SeetensorBoardAppSettingsBlock below.const -
DomainDefaultUserSettings.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
autoMountHomeEfs
→ Input<
String?> ? -
Indicates whether auto-mounting of an EFS volume is supported for the user profile. The
DefaultAsDomainvalue is only supported for user profiles. Do not use theDefaultAsDomainvalue when setting this parameter for a domain. Valid values are:Enabled,Disabled, andDefaultAsDomain.final -
canvasAppSettings
→ Input<
DomainDefaultUserSettingsCanvasAppSettings?> ? -
The Canvas app settings. See
canvasAppSettingsBlock below.final -
codeEditorAppSettings
→ Input<
DomainDefaultUserSettingsCodeEditorAppSettings?> ? -
The Code Editor application settings. See
codeEditorAppSettingsBlock below.final -
customFileSystemConfigs
→ Input<
List< ?DomainDefaultUserSettingsCustomFileSystemConfig> ?> -
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
customFileSystemConfigBlock below.final -
customPosixUserConfig
→ Input<
DomainDefaultUserSettingsCustomPosixUserConfig?> ? -
Details about the POSIX identity that is used for file system operations. See
customPosixUserConfigBlock below.final -
defaultLandingUri
→ Input<
String?> ? -
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.final -
executionRole
→ Input<
String> -
The execution role ARN for the user.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
jupyterLabAppSettings
→ Input<
DomainDefaultUserSettingsJupyterLabAppSettings?> ? -
The settings for the JupyterLab application. See
jupyterLabAppSettingsBlock below.final -
jupyterServerAppSettings
→ Input<
DomainDefaultUserSettingsJupyterServerAppSettings?> ? -
The Jupyter server's app settings. See
jupyterServerAppSettingsBlock below.final -
kernelGatewayAppSettings
→ Input<
DomainDefaultUserSettingsKernelGatewayAppSettings?> ? -
The kernel gateway app settings. See
kernelGatewayAppSettingsBlock below.final -
rSessionAppSettings
→ Input<
DomainDefaultUserSettingsRSessionAppSettings?> ? -
The RSession app settings. See
rSessionAppSettingsBlock below.final -
rStudioServerProAppSettings
→ Input<
DomainDefaultUserSettingsRStudioServerProAppSettings?> ? -
A collection of settings that configure user interaction with the RStudioServerPro app. See
rStudioServerProAppSettingsBlock below.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroups
→ Input<
List< ?String> ?> -
A list of security group IDs that will be attached to the user.
final
-
The sharing settings. See
sharingSettingsBlock below.final -
spaceStorageSettings
→ Input<
DomainDefaultUserSettingsSpaceStorageSettings?> ? -
The storage settings for a private space. See
spaceStorageSettingsBlock below.final -
studioWebPortal
→ Input<
String?> ? -
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 areENABLEDandDISABLED.final -
studioWebPortalSettings
→ Input<
DomainDefaultUserSettingsStudioWebPortalSettings?> ? -
The Studio Web Portal settings. See
studioWebPortalSettingsBlock below.final -
tensorBoardAppSettings
→ Input<
DomainDefaultUserSettingsTensorBoardAppSettings?> ? -
The TensorBoard app settings. See
tensorBoardAppSettingsBlock below.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited