Package software.amazon.awscdk.services.sagemaker

Class CfnDomain.UserSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sagemaker.CfnDomain.UserSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDomain.UserSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDomain.UserSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnDomain.UserSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDomain.UserSettingsProperty

An implementation for CfnDomain.UserSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.CfnDomain.UserSettingsProperty

CfnDomain.UserSettingsProperty.Builder, CfnDomain.UserSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDomain.UserSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDomain.UserSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDomain.UserSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDomain.UserSettingsProperty.Builder.

Method Details

getExecutionRole

public final String getExecutionRole()

Description copied from interface: CfnDomain.UserSettingsProperty

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.

Specified by:

getExecutionRole in interface CfnDomain.UserSettingsProperty

See Also:

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

getAutoMountHomeEfs

public final String getAutoMountHomeEfs()

Description copied from interface: CfnDomain.UserSettingsProperty

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.

Specified by:

getAutoMountHomeEfs in interface CfnDomain.UserSettingsProperty

See Also:

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

getCodeEditorAppSettings

public final Object getCodeEditorAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Specified by:

getCodeEditorAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getCustomFileSystemConfigs

public final Object getCustomFileSystemConfigs()

Description copied from interface: CfnDomain.UserSettingsProperty

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>

Specified by:

getCustomFileSystemConfigs in interface CfnDomain.UserSettingsProperty

See Also:

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

getCustomPosixUserConfig

public final Object getCustomPosixUserConfig()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Specified by:

getCustomPosixUserConfig in interface CfnDomain.UserSettingsProperty

See Also:

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

getDefaultLandingUri

public final String getDefaultLandingUri()

Description copied from interface: CfnDomain.UserSettingsProperty

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.

Specified by:

getDefaultLandingUri in interface CfnDomain.UserSettingsProperty

See Also:

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

getJupyterLabAppSettings

public final Object getJupyterLabAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Specified by:

getJupyterLabAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getJupyterServerAppSettings

public final Object getJupyterServerAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

The Jupyter server's app settings.

Returns union: either IResolvable or CfnDomain.JupyterServerAppSettingsProperty

Specified by:

getJupyterServerAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getKernelGatewayAppSettings

public final Object getKernelGatewayAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

The kernel gateway app settings.

Returns union: either IResolvable or CfnDomain.KernelGatewayAppSettingsProperty

Specified by:

getKernelGatewayAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getRSessionAppSettings

public final Object getRSessionAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

A collection of settings that configure the RSessionGateway app.

Returns union: either IResolvable or CfnDomain.RSessionAppSettingsProperty

Specified by:

getRSessionAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getRStudioServerProAppSettings

public final Object getRStudioServerProAppSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Returns union: either IResolvable or CfnDomain.RStudioServerProAppSettingsProperty

Specified by:

getRStudioServerProAppSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getSecurityGroups

public final List<String> getSecurityGroups()

Description copied from interface: CfnDomain.UserSettingsProperty

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.

Specified by:

getSecurityGroups in interface CfnDomain.UserSettingsProperty

See Also:

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

getSharingSettings

public final Object getSharingSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

Returns union: either IResolvable or CfnDomain.SharingSettingsProperty

Specified by:

getSharingSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getSpaceStorageSettings

public final Object getSpaceStorageSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Specified by:

getSpaceStorageSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

getStudioWebPortal

public final String getStudioWebPortal()

Description copied from interface: CfnDomain.UserSettingsProperty

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.

Specified by:

getStudioWebPortal in interface CfnDomain.UserSettingsProperty

See Also:

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

getStudioWebPortalSettings

public final Object getStudioWebPortalSettings()

Description copied from interface: CfnDomain.UserSettingsProperty

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

Specified by:

getStudioWebPortalSettings in interface CfnDomain.UserSettingsProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object