UserSettings
A collection of settings that apply to users in a domain. These settings are
specified when the CreateUserProfile API is called, and as DefaultUserSettings
when the CreateDomain API is called.
SecurityGroups is aggregated when specified in both calls. For all other
settings in UserSettings, the values specified in CreateUserProfile
take precedence over those specified in CreateDomain.
Contents
- CanvasAppSettings
-
The Canvas app settings.
Type: CanvasAppSettings object
Required: No
- CodeEditorAppSettings
-
The Code Editor application settings.
Type: CodeEditorAppSettings object
Required: No
- CustomFileSystemConfigs
-
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
Type: Array of CustomFileSystemConfig objects
Array Members: Maximum number of 2 items.
Required: No
- CustomPosixUserConfig
-
Details about the POSIX identity that is used for file system operations.
Type: CustomPosixUserConfig object
Required: No
- 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 ifStudioWebPortalis set toENABLED. -
app:JupyterServer:: Indicates that Studio Classic is the default experience.
Type: String
Length Constraints: Maximum length of 1023.
Required: No
-
- ExecutionRole
-
The execution role for the user.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$Required: No
- JupyterLabAppSettings
-
The settings for the JupyterLab application.
Type: JupyterLabAppSettings object
Required: No
- JupyterServerAppSettings
-
The Jupyter server's app settings.
Type: JupyterServerAppSettings object
Required: No
- KernelGatewayAppSettings
-
The kernel gateway app settings.
Type: KernelGatewayAppSettings object
Required: No
- RSessionAppSettings
-
A collection of settings that configure the
RSessionGatewayapp.Type: RSessionAppSettings object
Required: No
- RStudioServerProAppSettings
-
A collection of settings that configure user interaction with the
RStudioServerProapp.Type: RStudioServerProAppSettings object
Required: No
- SecurityGroups
-
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional when the
CreateDomain.AppNetworkAccessTypeparameter is set toPublicInternetOnly.Required when the
CreateDomain.AppNetworkAccessTypeparameter is set toVpcOnly, unless specified as part of theDefaultUserSettingsfor 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.
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Maximum length of 32.
Pattern:
[-0-9a-zA-Z]+Required: No
- SharingSettings
-
Specifies options for sharing Amazon SageMaker Studio notebooks.
Type: SharingSettings object
Required: No
- SpaceStorageSettings
-
The storage settings for a private space.
Type: DefaultSpaceStorageSettings object
Required: No
- 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.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- TensorBoardAppSettings
-
The TensorBoard app settings.
Type: TensorBoardAppSettings object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: