Interface CfnUserProfile.JupyterLabAppSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProfile.JupyterLabAppSettingsProperty.Jsii$Proxy

Enclosing class:

CfnUserProfile

@Stability(Stable)
public static interface CfnUserProfile.JupyterLabAppSettingsProperty
extends software.amazon.jsii.JsiiSerializable

The settings for the JupyterLab application.

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.*;
 JupyterLabAppSettingsProperty jupyterLabAppSettingsProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserProfile.JupyterLabAppSettingsProperty.Builder	builder()
default Object	getAppLifecycleManagement()	Indicates whether idle shutdown is activated for JupyterLab applications.
default String	getBuiltInLifecycleConfigArn()	The lifecycle configuration that runs before the default lifecycle configuration.
default Object	getCodeRepositories()	A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
default Object	getCustomImages()	A list of custom SageMaker images that are configured to run as a JupyterLab app.
default Object	getDefaultResourceSpec()	The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
default List<String>	getLifecycleConfigArns()	The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppLifecycleManagement

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

Indicates whether idle shutdown is activated for JupyterLab applications.

See Also:

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

getBuiltInLifecycleConfigArn

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

The lifecycle configuration that runs before the default lifecycle configuration.

See Also:

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

getCodeRepositories

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

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

See Also:

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

getCustomImages

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

A list of custom SageMaker images that are configured to run as a JupyterLab app.

See Also:

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

getDefaultResourceSpec

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

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.

See Also:

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

getLifecycleConfigArns

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

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain.

To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

See Also:

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

builder

@Stability(Stable)
static CfnUserProfile.JupyterLabAppSettingsProperty.Builder builder()

Returns:

a CfnUserProfile.JupyterLabAppSettingsProperty.Builder of CfnUserProfile.JupyterLabAppSettingsProperty