Package software.amazon.awscdk.services.sagemaker

Interface CfnUserProfile.CodeEditorAppSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProfile.CodeEditorAppSettingsProperty.Jsii$Proxy

Enclosing class:

CfnUserProfile

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

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker .

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.*;
 CodeEditorAppSettingsProperty codeEditorAppSettingsProperty = CodeEditorAppSettingsProperty.builder()
         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                 .idleSettings(IdleSettingsProperty.builder()
                         .idleTimeoutInMinutes(123)
                         .lifecycleManagement("lifecycleManagement")
                         .maxIdleTimeoutInMinutes(123)
                         .minIdleTimeoutInMinutes(123)
                         .build())
                 .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-codeeditorappsettings.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserProfile.CodeEditorAppSettingsProperty.Builder	builder()
default Object	getAppLifecycleManagement()	Settings that are used to configure and manage the lifecycle of CodeEditor applications.
default Object	getCustomImages()	A list of custom SageMaker images that are configured to run as a Code Editor app.
default Object	getDefaultResourceSpec()	The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app.
default List<String>	getLifecycleConfigArns()	The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppLifecycleManagement

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

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

See Also:

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

getCustomImages

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-codeeditorappsettings.html#cfn-sagemaker-userprofile-codeeditorappsettings-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 Code Editor app.

See Also:

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

getLifecycleConfigArns

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

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

See Also:

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

builder

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

Returns:

a CfnUserProfile.CodeEditorAppSettingsProperty.Builder of CfnUserProfile.CodeEditorAppSettingsProperty