AWS::SageMaker::Domain UserSettings - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::Domain UserSettings

A collection of settings that apply to users of Amazon SageMaker Studio. 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

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.

Required: No

Type: String

Allowed values: Enabled | Disabled | DefaultAsDomain

Update requires: No interruption

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.

Required: No

Type: CodeEditorAppSettings

Update requires: No interruption

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.

Required: No

Type: Array of CustomFileSystemConfig

Minimum: 0

Maximum: 2

Update requires: No interruption

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.

Required: No

Type: CustomPosixUserConfig

Update requires: No interruption

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.

Required: No

Type: String

Maximum: 1023

Update requires: No interruption

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.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Minimum: 20

Maximum: 2048

Update requires: No interruption

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.

Required: No

Type: JupyterLabAppSettings

Update requires: No interruption

JupyterServerAppSettings

The Jupyter server's app settings.

Required: No

Type: JupyterServerAppSettings

Update requires: No interruption

KernelGatewayAppSettings

The kernel gateway app settings.

Required: No

Type: KernelGatewayAppSettings

Update requires: No interruption

RSessionAppSettings

A collection of settings that configure the RSessionGateway app.

Required: No

Type: RSessionAppSettings

Update requires: No interruption

RStudioServerProAppSettings

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

Required: No

Type: RStudioServerProAppSettings

Update requires: No interruption

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.

Required: No

Type: Array of String

Minimum: 0

Maximum: 32 | 5

Update requires: No interruption

SharingSettings

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Required: No

Type: SharingSettings

Update requires: No interruption

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.

Required: No

Type: DefaultSpaceStorageSettings

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

StudioWebPortalSettings

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

Required: No

Type: StudioWebPortalSettings

Update requires: No interruption