AWS::SageMaker::Domain UserSettings - AWS CloudFormation

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.


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



The execution role for the user.

Required: No

Type: String

Minimum: 20

Maximum: 2048

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

Update requires: No interruption


The Jupyter server's app settings.

Required: No

Type: JupyterServerAppSettings

Update requires: No interruption


The kernel gateway app settings.

Required: No

Type: KernelGatewayAppSettings

Update requires: No interruption


A collection of settings that configure the RSessionGateway app.

Required: No

Type: RSessionAppSettings

Update requires: No interruption


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

Required: No

Type: RStudioServerProAppSettings

Update requires: No interruption


The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

Required: No

Type: List of String

Maximum: 5

Update requires: No interruption


Specifies options for sharing SageMaker Studio notebooks.

Required: No

Type: SharingSettings

Update requires: No interruption