Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.CodeEditorAppSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.CodeEditorAppSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.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())
         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
         .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-domain-codeeditorappsettings.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomain.CodeEditorAppSettingsProperty.Builder	builder()
default Object	getAppLifecycleManagement()	Settings that are used to configure and manage the lifecycle of CodeEditor applications.
default String	getBuiltInLifecycleConfigArn()	The lifecycle configuration that runs before the default lifecycle configuration.
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.

Returns union: either IResolvable or CfnDomain.AppLifecycleManagementProperty

See Also:

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

getBuiltInLifecycleConfigArn

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

The lifecycle configuration that runs before the default lifecycle configuration.

It can override changes made in the default lifecycle configuration.

See Also:

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

getCustomImages

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomain.CustomImageProperty>

See Also:

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

Returns union: either IResolvable or CfnDomain.ResourceSpecProperty

See Also:

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

builder

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

Returns:

a CfnDomain.CodeEditorAppSettingsProperty.Builder of CfnDomain.CodeEditorAppSettingsProperty