Skip to content
v2.274.0

CodeEditorAppSettingsProperty Struct ​

The Code Editor application settings.

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const codeEditorAppSettingsProperty: sagemaker.CfnUserProfile.CodeEditorAppSettingsProperty = {
  appLifecycleManagement: {
    idleSettings: {
      idleTimeoutInMinutes: 123,
      lifecycleManagement: 'lifecycleManagement',
      maxIdleTimeoutInMinutes: 123,
      minIdleTimeoutInMinutes: 123,
    },
  },
  builtInLifecycleConfigArn: 'builtInLifecycleConfigArn',
  customImages: [{
    appImageConfigName: 'appImageConfigName',
    imageName: 'imageName',

    // the properties below are optional
    imageVersionNumber: 123,
  }],
  defaultResourceSpec: {
    instanceType: 'instanceType',
    lifecycleConfigArn: 'lifecycleConfigArn',
    sageMakerImageArn: 'sageMakerImageArn',
    sageMakerImageVersionArn: 'sageMakerImageVersionArn',
    trainingPlanArn: 'trainingPlanArn',
  },
  lifecycleConfigArns: ['lifecycleConfigArns'],
};

Properties ​

appLifecycleManagementoptionalIResolvable | CfnUserProfile.AppLifecycleManagementPropertyapp_lifecycle_managementoptionaltyping.Union[IResolvable, AppLifecycleManagementProperty]appLifecycleManagementoptionalIResolvableAppLifecycleManagementoptionalIResolvableAppLifecycleManagementoptionalinterface{}#
Settings that are used to configure and manage the lifecycle of CodeEditor applications.
builtInLifecycleConfigArnoptionalstringbuilt_in_lifecycle_config_arnoptionalstrbuiltInLifecycleConfigArnoptionalStringBuiltInLifecycleConfigArnoptionalstringBuiltInLifecycleConfigArnoptional*string#
The lifecycle configuration that runs before the default lifecycle configuration.

It can override changes made in the default lifecycle configuration.

customImagesoptionalIResolvable | IResolvable | CfnUserProfile.CustomImageProperty[]custom_imagesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomImageProperty]]]customImagesoptionalIResolvableCustomImagesoptionalIResolvableCustomImagesoptionalinterface{}#
A list of custom SageMaker images that are configured to run as a Code Editor app.
defaultResourceSpecoptionalIResolvable | CfnUserProfile.ResourceSpecPropertydefault_resource_specoptionaltyping.Union[IResolvable, ResourceSpecProperty]defaultResourceSpecoptionalIResolvableDefaultResourceSpecoptionalIResolvableDefaultResourceSpecoptionalinterface{}#
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app.
lifecycleConfigArnsoptionalstring[]lifecycle_config_arnsoptionaltyping.List[str]lifecycleConfigArnsoptionalList<String>LifecycleConfigArnsoptionalstring[]LifecycleConfigArnsoptional*[]*string#
The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.