Interface CfnUserProfilePropsMixin.IJupyterLabAppSettingsProperty

The settings for the JupyterLab application.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.SageMaker

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnUserProfilePropsMixin.IJupyterLabAppSettingsProperty

Syntax (vb)

Public Interface CfnUserProfilePropsMixin.IJupyterLabAppSettingsProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.SageMaker;

             var jupyterLabAppSettingsProperty = new JupyterLabAppSettingsProperty {
                 AppLifecycleManagement = new AppLifecycleManagementProperty {
                     IdleSettings = new IdleSettingsProperty {
                         IdleTimeoutInMinutes = 123,
                         LifecycleManagement = "lifecycleManagement",
                         MaxIdleTimeoutInMinutes = 123,
                         MinIdleTimeoutInMinutes = 123
                     }
                 },
                 BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                 CodeRepositories = new [] { new CodeRepositoryProperty {
                     RepositoryUrl = "repositoryUrl"
                 } },
                 CustomImages = new [] { new CustomImageProperty {
                     AppImageConfigName = "appImageConfigName",
                     ImageName = "imageName",
                     ImageVersionNumber = 123
                 } },
                 DefaultResourceSpec = new ResourceSpecProperty {
                     InstanceType = "instanceType",
                     LifecycleConfigArn = "lifecycleConfigArn",
                     SageMakerImageArn = "sageMakerImageArn",
                     SageMakerImageVersionArn = "sageMakerImageVersionArn"
                 },
                 LifecycleConfigArns = new [] { "lifecycleConfigArns" }
             };

Synopsis

Properties

AppLifecycleManagement	Indicates whether idle shutdown is activated for JupyterLab applications.
BuiltInLifecycleConfigArn	The lifecycle configuration that runs before the default lifecycle configuration.
CodeRepositories	A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
CustomImages	A list of custom SageMaker images that are configured to run as a JupyterLab app.
DefaultResourceSpec	The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
LifecycleConfigArns	The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain.

Properties

AppLifecycleManagement

Indicates whether idle shutdown is activated for JupyterLab applications.

object? AppLifecycleManagement { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IAppLifecycleManagementProperty

BuiltInLifecycleConfigArn

The lifecycle configuration that runs before the default lifecycle configuration.

string? BuiltInLifecycleConfigArn { get; }

Property Value

string

Remarks

It can override changes made in the default lifecycle configuration.

CodeRepositories

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

object? CodeRepositories { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnUserProfilePropsMixin.ICodeRepositoryProperty)[]

CustomImages

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

object? CustomImages { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnUserProfilePropsMixin.ICustomImageProperty)[]

DefaultResourceSpec

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

object? DefaultResourceSpec { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnUserProfilePropsMixin.IResourceSpecProperty

LifecycleConfigArns

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

string[]? LifecycleConfigArns { get; }

Property Value

string[]

Remarks

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