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.

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.

Type: String

Valid Values: Enabled | Disabled | DefaultAsDomain

Required: No

CanvasAppSettings

The Canvas app settings.

SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

Type: CanvasAppSettings object

Required: No

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.

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 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.

Type: Array of CustomFileSystemConfig objects

Array Members: Maximum number of 10 items.

Required: No

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.

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 if StudioWebPortal is set to ENABLED.
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.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

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.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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 RSessionGateway app.

Type: RSessionAppSettings object

Required: No

RStudioServerProAppSettings

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

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.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.

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 AI Studio notebooks.

Type: SharingSettings object

Required: No

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.

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 | DISABLED

Required: No

StudioWebPortalSettings

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Type: StudioWebPortalSettings object

Required: No

TensorBoardAppSettings

The TensorBoard app settings.

Type: TensorBoardAppSettings object

Required: No

UserSettings

Contents

See Also