/AWS1/CL_SGMUSERSETTINGS

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_executionrole TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

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.

it_securitygroups TYPE /AWS1/CL_SGMSECURITYGROUPIDS_W=>TT_SECURITYGROUPIDS TT_SECURITYGROUPIDS

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.

io_sharingsettings TYPE REF TO /AWS1/CL_SGMSHARINGSETTINGS /AWS1/CL_SGMSHARINGSETTINGS

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

io_jupyterserverappsettings TYPE REF TO /AWS1/CL_SGMJUPYTERSERVERAPP00 /AWS1/CL_SGMJUPYTERSERVERAPP00

The Jupyter server's app settings.

io_kernelgatewayappsettings TYPE REF TO /AWS1/CL_SGMKERNELGWAPPSTGS /AWS1/CL_SGMKERNELGWAPPSTGS

The kernel gateway app settings.

io_tensorboardappsettings TYPE REF TO /AWS1/CL_SGMTENSORBOARDAPPSTGS /AWS1/CL_SGMTENSORBOARDAPPSTGS

The TensorBoard app settings.

io_rstudioserverproappstgs TYPE REF TO /AWS1/CL_SGMRSTUDIOSERVERPRO00 /AWS1/CL_SGMRSTUDIOSERVERPRO00

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

io_rsessionappsettings TYPE REF TO /AWS1/CL_SGMRSESSIONAPPSTGS /AWS1/CL_SGMRSESSIONAPPSTGS

A collection of settings that configure the RSessionGateway app.

io_canvasappsettings TYPE REF TO /AWS1/CL_SGMCANVASAPPSETTINGS /AWS1/CL_SGMCANVASAPPSETTINGS

The Canvas app settings.

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

io_codeeditorappsettings TYPE REF TO /AWS1/CL_SGMCODEEDITORAPPSTGS /AWS1/CL_SGMCODEEDITORAPPSTGS

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.

io_jupyterlabappsettings TYPE REF TO /AWS1/CL_SGMJUPYTERLABAPPSTGS /AWS1/CL_SGMJUPYTERLABAPPSTGS

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.

io_spacestoragesettings TYPE REF TO /AWS1/CL_SGMDEFSPACESTRGSTGS /AWS1/CL_SGMDEFSPACESTRGSTGS

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.

iv_defaultlandinguri TYPE /AWS1/SGMLANDINGURI /AWS1/SGMLANDINGURI

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.

iv_studiowebportal TYPE /AWS1/SGMSTUDIOWEBPORTAL /AWS1/SGMSTUDIOWEBPORTAL

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.

io_customposixuserconfig TYPE REF TO /AWS1/CL_SGMCUSTOMPOSIXUSERCFG /AWS1/CL_SGMCUSTOMPOSIXUSERCFG

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.

it_customfilesystemconfigs TYPE /AWS1/CL_SGMCUSTFILESYSTEMCFG=>TT_CUSTOMFILESYSTEMCONFIGS TT_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.

io_studiowebportalsettings TYPE REF TO /AWS1/CL_SGMSTUDIOWEBPORTALS00 /AWS1/CL_SGMSTUDIOWEBPORTALS00

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

iv_automounthomeefs TYPE /AWS1/SGMAUTOMOUNTHOMEEFS /AWS1/SGMAUTOMOUNTHOMEEFS

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.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_EXECUTIONROLE()	Getter for EXECUTIONROLE, with configurable default
ASK_EXECUTIONROLE()	Getter for EXECUTIONROLE w/ exceptions if field has no value
HAS_EXECUTIONROLE()	Determine if EXECUTIONROLE has a value

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.

Accessible with the following methods

Method	Description
GET_SECURITYGROUPS()	Getter for SECURITYGROUPS, with configurable default
ASK_SECURITYGROUPS()	Getter for SECURITYGROUPS w/ exceptions if field has no valu
HAS_SECURITYGROUPS()	Determine if SECURITYGROUPS has a value

SharingSettings

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Accessible with the following methods

Method	Description
GET_SHARINGSETTINGS()	Getter for SHARINGSETTINGS

JupyterServerAppSettings

The Jupyter server's app settings.

Accessible with the following methods

Method	Description
GET_JUPYTERSERVERAPPSETTINGS()	Getter for JUPYTERSERVERAPPSETTINGS

KernelGatewayAppSettings

The kernel gateway app settings.

Accessible with the following methods

Method	Description
GET_KERNELGATEWAYAPPSETTINGS()	Getter for KERNELGATEWAYAPPSETTINGS

TensorBoardAppSettings

The TensorBoard app settings.

Accessible with the following methods

Method	Description
GET_TENSORBOARDAPPSETTINGS()	Getter for TENSORBOARDAPPSETTINGS

RStudioServerProAppSettings

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

Accessible with the following methods

Method	Description
GET_RSTUDIOSERVERPROAPPSTGS()	Getter for RSTUDIOSERVERPROAPPSETTINGS

RSessionAppSettings

A collection of settings that configure the RSessionGateway app.

Accessible with the following methods

Method	Description
GET_RSESSIONAPPSETTINGS()	Getter for RSESSIONAPPSETTINGS

CanvasAppSettings

The Canvas app settings.

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

Accessible with the following methods

Method	Description
GET_CANVASAPPSETTINGS()	Getter for CANVASAPPSETTINGS

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.

Accessible with the following methods

Method	Description
GET_CODEEDITORAPPSETTINGS()	Getter for CODEEDITORAPPSETTINGS

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.

Accessible with the following methods

Method	Description
GET_JUPYTERLABAPPSETTINGS()	Getter for JUPYTERLABAPPSETTINGS

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.

Accessible with the following methods

Method	Description
GET_SPACESTORAGESETTINGS()	Getter for SPACESTORAGESETTINGS

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.

Accessible with the following methods

Method	Description
GET_DEFAULTLANDINGURI()	Getter for DEFAULTLANDINGURI, with configurable default
ASK_DEFAULTLANDINGURI()	Getter for DEFAULTLANDINGURI w/ exceptions if field has no v
HAS_DEFAULTLANDINGURI()	Determine if DEFAULTLANDINGURI has a value

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.

Accessible with the following methods

Method	Description
GET_STUDIOWEBPORTAL()	Getter for STUDIOWEBPORTAL, with configurable default
ASK_STUDIOWEBPORTAL()	Getter for STUDIOWEBPORTAL w/ exceptions if field has no val
HAS_STUDIOWEBPORTAL()	Determine if STUDIOWEBPORTAL has a value

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.

Accessible with the following methods

Method	Description
GET_CUSTOMPOSIXUSERCONFIG()	Getter for CUSTOMPOSIXUSERCONFIG

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.

Accessible with the following methods

Method	Description
GET_CUSTOMFILESYSTEMCONFIGS()	Getter for CUSTOMFILESYSTEMCONFIGS, with configurable defaul
ASK_CUSTOMFILESYSTEMCONFIGS()	Getter for CUSTOMFILESYSTEMCONFIGS w/ exceptions if field ha
HAS_CUSTOMFILESYSTEMCONFIGS()	Determine if CUSTOMFILESYSTEMCONFIGS has a value

StudioWebPortalSettings

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

Accessible with the following methods

Method	Description
GET_STUDIOWEBPORTALSETTINGS()	Getter for STUDIOWEBPORTALSETTINGS

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.

Accessible with the following methods

Method	Description
GET_AUTOMOUNTHOMEEFS()	Getter for AUTOMOUNTHOMEEFS, with configurable default
ASK_AUTOMOUNTHOMEEFS()	Getter for AUTOMOUNTHOMEEFS w/ exceptions if field has no va
HAS_AUTOMOUNTHOMEEFS()	Determine if AUTOMOUNTHOMEEFS has a value