Package software.amazon.awscdk.services.sagemaker

Interface CfnSpace.SpaceSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSpace.SpaceSettingsProperty.Jsii$Proxy

Enclosing class:

CfnSpace

@Stability(Stable)
public static interface CfnSpace.SpaceSettingsProperty
extends software.amazon.jsii.JsiiSerializable

A collection of space settings.

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.*;
 SpaceSettingsProperty spaceSettingsProperty = SpaceSettingsProperty.builder()
         .appType("appType")
         .codeEditorAppSettings(SpaceCodeEditorAppSettingsProperty.builder()
                 .appLifecycleManagement(SpaceAppLifecycleManagementProperty.builder()
                         .idleSettings(SpaceIdleSettingsProperty.builder()
                                 .idleTimeoutInMinutes(123)
                                 .build())
                         .build())
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .build())
         .customFileSystems(List.of(CustomFileSystemProperty.builder()
                 .efsFileSystem(EFSFileSystemProperty.builder()
                         .fileSystemId("fileSystemId")
                         .build())
                 .fSxLustreFileSystem(FSxLustreFileSystemProperty.builder()
                         .fileSystemId("fileSystemId")
                         .build())
                 .s3FileSystem(S3FileSystemProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build()))
         .jupyterLabAppSettings(SpaceJupyterLabAppSettingsProperty.builder()
                 .appLifecycleManagement(SpaceAppLifecycleManagementProperty.builder()
                         .idleSettings(SpaceIdleSettingsProperty.builder()
                                 .idleTimeoutInMinutes(123)
                                 .build())
                         .build())
                 .codeRepositories(List.of(CodeRepositoryProperty.builder()
                         .repositoryUrl("repositoryUrl")
                         .build()))
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .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())
         .remoteAccess("remoteAccess")
         .spaceManagedResources("spaceManagedResources")
         .spaceStorageSettings(SpaceStorageSettingsProperty.builder()
                 .ebsStorageSettings(EbsStorageSettingsProperty.builder()
                         .ebsVolumeSizeInGb(123)
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSpace.SpaceSettingsProperty.Builder	builder()
default String	getAppType()	The type of app created within the space.
default Object	getCodeEditorAppSettings()	The Code Editor application settings.
default Object	getCustomFileSystems()	A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.
default Object	getJupyterLabAppSettings()	The settings for the JupyterLab application.
default Object	getJupyterServerAppSettings()	The JupyterServer app settings.
default Object	getKernelGatewayAppSettings()	The KernelGateway app settings.
default String	getRemoteAccess()	A setting that enables or disables remote access for a SageMaker space.
default String	getSpaceManagedResources()	If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:.
default Object	getSpaceStorageSettings()	The storage settings for a space.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppType

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

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-apptype

getCodeEditorAppSettings

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

The Code Editor application settings.

Returns union: either IResolvable or CfnSpace.SpaceCodeEditorAppSettingsProperty

See Also:

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

getCustomFileSystems

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

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSpace.CustomFileSystemProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-customfilesystems

getJupyterLabAppSettings

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

The settings for the JupyterLab application.

Returns union: either IResolvable or CfnSpace.SpaceJupyterLabAppSettingsProperty

See Also:

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

getJupyterServerAppSettings

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

The JupyterServer app settings.

Returns union: either IResolvable or CfnSpace.JupyterServerAppSettingsProperty

See Also:

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

getKernelGatewayAppSettings

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

The KernelGateway app settings.

Returns union: either IResolvable or CfnSpace.KernelGatewayAppSettingsProperty

See Also:

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

getRemoteAccess

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

A setting that enables or disables remote access for a SageMaker space.

When enabled, this allows you to connect to the remote space from your local IDE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-remoteaccess

getSpaceManagedResources

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

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:.

• The user profile that possesses the space.
• The app that the space contains.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacemanagedresources

getSpaceStorageSettings

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

The storage settings for a space.

Returns union: either IResolvable or CfnSpace.SpaceStorageSettingsProperty

See Also:

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

builder

@Stability(Stable)
static CfnSpace.SpaceSettingsProperty.Builder builder()

Returns:

a CfnSpace.SpaceSettingsProperty.Builder of CfnSpace.SpaceSettingsProperty