Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.UserSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.UserSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.UserSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 UserSettingsProperty userSettingsProperty = UserSettingsProperty.builder()
         .executionRole("executionRole")
         // the properties below are optional
         .autoMountHomeEfs("autoMountHomeEfs")
         .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder()
                 .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                         .idleSettings(IdleSettingsProperty.builder()
                                 .idleTimeoutInMinutes(123)
                                 .lifecycleManagement("lifecycleManagement")
                                 .maxIdleTimeoutInMinutes(123)
                                 .minIdleTimeoutInMinutes(123)
                                 .build())
                         .build())
                 .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                 .customImages(List.of(CustomImageProperty.builder()
                         .appImageConfigName("appImageConfigName")
                         .imageName("imageName")
                         // the properties below are optional
                         .imageVersionNumber(123)
                         .build()))
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                 .build())
         .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
                 .efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
                         .fileSystemId("fileSystemId")
                         // the properties below are optional
                         .fileSystemPath("fileSystemPath")
                         .build())
                 .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                         .fileSystemId("fileSystemId")
                         // the properties below are optional
                         .fileSystemPath("fileSystemPath")
                         .build())
                 .s3FileSystemConfig(S3FileSystemConfigProperty.builder()
                         .mountPath("mountPath")
                         .s3Uri("s3Uri")
                         .build())
                 .build()))
         .customPosixUserConfig(CustomPosixUserConfigProperty.builder()
                 .gid(123)
                 .uid(123)
                 .build())
         .defaultLandingUri("defaultLandingUri")
         .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
                 .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                         .idleSettings(IdleSettingsProperty.builder()
                                 .idleTimeoutInMinutes(123)
                                 .lifecycleManagement("lifecycleManagement")
                                 .maxIdleTimeoutInMinutes(123)
                                 .minIdleTimeoutInMinutes(123)
                                 .build())
                         .build())
                 .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                 .codeRepositories(List.of(CodeRepositoryProperty.builder()
                         .repositoryUrl("repositoryUrl")
                         .build()))
                 .customImages(List.of(CustomImageProperty.builder()
                         .appImageConfigName("appImageConfigName")
                         .imageName("imageName")
                         // the properties below are optional
                         .imageVersionNumber(123)
                         .build()))
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                 .build())
         .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                 .build())
         .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                 .customImages(List.of(CustomImageProperty.builder()
                         .appImageConfigName("appImageConfigName")
                         .imageName("imageName")
                         // the properties below are optional
                         .imageVersionNumber(123)
                         .build()))
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                 .build())
         .rSessionAppSettings(RSessionAppSettingsProperty.builder()
                 .customImages(List.of(CustomImageProperty.builder()
                         .appImageConfigName("appImageConfigName")
                         .imageName("imageName")
                         // the properties below are optional
                         .imageVersionNumber(123)
                         .build()))
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .build())
         .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                 .accessStatus("accessStatus")
                 .userGroup("userGroup")
                 .build())
         .securityGroups(List.of("securityGroups"))
         .sharingSettings(SharingSettingsProperty.builder()
                 .notebookOutputOption("notebookOutputOption")
                 .s3KmsKeyId("s3KmsKeyId")
                 .s3OutputPath("s3OutputPath")
                 .build())
         .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
                 .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
                         .defaultEbsVolumeSizeInGb(123)
                         .maximumEbsVolumeSizeInGb(123)
                         .build())
                 .build())
         .studioWebPortal("studioWebPortal")
         .studioWebPortalSettings(StudioWebPortalSettingsProperty.builder()
                 .hiddenAppTypes(List.of("hiddenAppTypes"))
                 .hiddenInstanceTypes(List.of("hiddenInstanceTypes"))
                 .hiddenMlTools(List.of("hiddenMlTools"))
                 .hiddenSageMakerImageVersionAliases(List.of(HiddenSageMakerImageProperty.builder()
                         .sageMakerImageName("sageMakerImageName")
                         .versionAliases(List.of("versionAliases"))
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.UserSettingsProperty.Builder	A builder for CfnDomain.UserSettingsProperty
static final class	CfnDomain.UserSettingsProperty.Jsii$Proxy	An implementation for CfnDomain.UserSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.UserSettingsProperty.Builder	builder()
default String	getAutoMountHomeEfs()	Indicates whether auto-mounting of an EFS volume is supported for the user profile.
default Object	getCodeEditorAppSettings()	The Code Editor application settings.
default Object	getCustomFileSystemConfigs()	The settings for assigning a custom file system to a user profile.
default Object	getCustomPosixUserConfig()	Details about the POSIX identity that is used for file system operations.
default String	getDefaultLandingUri()	The default experience that the user is directed to when accessing the domain.
String	getExecutionRole()	The execution role for the user.
default Object	getJupyterLabAppSettings()	The settings for the JupyterLab application.
default Object	getJupyterServerAppSettings()	The Jupyter server's app settings.
default Object	getKernelGatewayAppSettings()	The kernel gateway app settings.
default Object	getRSessionAppSettings()	A collection of settings that configure the RSessionGateway app.
default Object	getRStudioServerProAppSettings()	A collection of settings that configure user interaction with the RStudioServerPro app.
default List<String>	getSecurityGroups()	The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
default Object	getSharingSettings()	Specifies options for sharing Amazon SageMaker AI Studio notebooks.
default Object	getSpaceStorageSettings()	The storage settings for a space.
default String	getStudioWebPortal()	Whether the user can access Studio.
default Object	getStudioWebPortalSettings()	Studio settings.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRole

@Stability(Stable)
@NotNull
String getExecutionRole()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-executionrole

getAutoMountHomeEfs

@Stability(Stable)
@Nullable
default String getAutoMountHomeEfs()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-automounthomeefs

getCodeEditorAppSettings

@Stability(Stable)
@Nullable
default Object getCodeEditorAppSettings()

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.

Returns union: either IResolvable or CfnDomain.CodeEditorAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-codeeditorappsettings

getCustomFileSystemConfigs

@Stability(Stable)
@Nullable
default Object getCustomFileSystemConfigs()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomain.CustomFileSystemConfigProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customfilesystemconfigs

getCustomPosixUserConfig

@Stability(Stable)
@Nullable
default Object getCustomPosixUserConfig()

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.

Returns union: either IResolvable or CfnDomain.CustomPosixUserConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customposixuserconfig

getDefaultLandingUri

@Stability(Stable)
@Nullable
default String getDefaultLandingUri()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-defaultlandinguri

getJupyterLabAppSettings

@Stability(Stable)
@Nullable
default Object getJupyterLabAppSettings()

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.

Returns union: either IResolvable or CfnDomain.JupyterLabAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterlabappsettings

getJupyterServerAppSettings

@Stability(Stable)
@Nullable
default Object getJupyterServerAppSettings()

The Jupyter server's app settings.

Returns union: either IResolvable or CfnDomain.JupyterServerAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-jupyterserverappsettings

getKernelGatewayAppSettings

@Stability(Stable)
@Nullable
default Object getKernelGatewayAppSettings()

The kernel gateway app settings.

Returns union: either IResolvable or CfnDomain.KernelGatewayAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-kernelgatewayappsettings

getRSessionAppSettings

@Stability(Stable)
@Nullable
default Object getRSessionAppSettings()

A collection of settings that configure the RSessionGateway app.

Returns union: either IResolvable or CfnDomain.RSessionAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rsessionappsettings

getRStudioServerProAppSettings

@Stability(Stable)
@Nullable
default Object getRStudioServerProAppSettings()

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

Returns union: either IResolvable or CfnDomain.RStudioServerProAppSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rstudioserverproappsettings

getSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getSecurityGroups()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-securitygroups

getSharingSettings

@Stability(Stable)
@Nullable
default Object getSharingSettings()

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Returns union: either IResolvable or CfnDomain.SharingSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-sharingsettings

getSpaceStorageSettings

@Stability(Stable)
@Nullable
default Object getSpaceStorageSettings()

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.

Returns union: either IResolvable or CfnDomain.DefaultSpaceStorageSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-spacestoragesettings

getStudioWebPortal

@Stability(Stable)
@Nullable
default String getStudioWebPortal()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportal

getStudioWebPortalSettings

@Stability(Stable)
@Nullable
default Object getStudioWebPortalSettings()

Studio settings.

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

Returns union: either IResolvable or CfnDomain.StudioWebPortalSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportalsettings

builder

@Stability(Stable)
static CfnDomain.UserSettingsProperty.Builder builder()

Returns:

a CfnDomain.UserSettingsProperty.Builder of CfnDomain.UserSettingsProperty