AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.SageMaker.Model.UserSettings

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class UserSettings

The UserSettings type exposes the following members

Constructors

NameDescription
Public Method UserSettings()

Properties

NameTypeDescription
Public Property CanvasAppSettings Amazon.SageMaker.Model.CanvasAppSettings

Gets and sets the property CanvasAppSettings.

The Canvas app settings.

Public Property CodeEditorAppSettings Amazon.SageMaker.Model.CodeEditorAppSettings

Gets and sets the property CodeEditorAppSettings.

The Code Editor application settings.

Public Property CustomFileSystemConfigs System.Collections.Generic.List<Amazon.SageMaker.Model.CustomFileSystemConfig>

Gets and sets the property CustomFileSystemConfigs.

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

Public Property CustomPosixUserConfig Amazon.SageMaker.Model.CustomPosixUserConfig

Gets and sets the property CustomPosixUserConfig.

Details about the POSIX identity that is used for file system operations.

Public Property DefaultLandingUri System.String

Gets and sets the property 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.

Public Property ExecutionRole System.String

Gets and sets the property ExecutionRole.

The execution role for the user.

Public Property JupyterLabAppSettings Amazon.SageMaker.Model.JupyterLabAppSettings

Gets and sets the property JupyterLabAppSettings.

The settings for the JupyterLab application.

Public Property JupyterServerAppSettings Amazon.SageMaker.Model.JupyterServerAppSettings

Gets and sets the property JupyterServerAppSettings.

The Jupyter server's app settings.

Public Property KernelGatewayAppSettings Amazon.SageMaker.Model.KernelGatewayAppSettings

Gets and sets the property KernelGatewayAppSettings.

The kernel gateway app settings.

Public Property RSessionAppSettings Amazon.SageMaker.Model.RSessionAppSettings

Gets and sets the property RSessionAppSettings.

A collection of settings that configure the RSessionGateway app.

Public Property RStudioServerProAppSettings Amazon.SageMaker.Model.RStudioServerProAppSettings

Gets and sets the property RStudioServerProAppSettings.

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

Public Property SecurityGroups System.Collections.Generic.List<System.String>

Gets and sets the property 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 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.

Public Property SharingSettings Amazon.SageMaker.Model.SharingSettings

Gets and sets the property SharingSettings.

Specifies options for sharing Amazon SageMaker Studio notebooks.

Public Property SpaceStorageSettings Amazon.SageMaker.Model.DefaultSpaceStorageSettings

Gets and sets the property SpaceStorageSettings.

The storage settings for a space.

Public Property StudioWebPortal Amazon.SageMaker.StudioWebPortal

Gets and sets the property 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.

Public Property TensorBoardAppSettings Amazon.SageMaker.Model.TensorBoardAppSettings

Gets and sets the property TensorBoardAppSettings.

The TensorBoard app settings.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5