UserSettings - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.


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.



The Canvas app settings.

Type: CanvasAppSettings object

Required: No


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


The Jupyter server's app settings.

Type: JupyterServerAppSettings object

Required: No


The kernel gateway app settings.

Type: KernelGatewayAppSettings object

Required: No


A collection of settings that configure the RSessionGateway app.

Type: RSessionAppSettings object

Required: No


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

Type: RStudioServerProAppSettings object

Required: No


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.

Type: Array of strings

Array Members: Maximum number of 5 items.

Length Constraints: Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

Required: No


Specifies options for sharing SageMaker Studio notebooks.

Type: SharingSettings object

Required: No


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: