CodeEditorAppSettings
The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
Contents
- AppLifecycleManagement
-
Settings that are used to configure and manage the lifecycle of CodeEditor applications.
Type: AppLifecycleManagement object
Required: No
- BuiltInLifecycleConfigArn
-
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$
Required: No
- CustomImages
-
A list of custom SageMaker images that are configured to run as a Code Editor app.
Type: Array of CustomImage objects
Array Members: Maximum number of 200 items.
Required: No
- DefaultResourceSpec
-
Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
Note
When both
SageMakerImageVersionArn
andSageMakerImageArn
are passed,SageMakerImageVersionArn
is used. Any updates toSageMakerImageArn
will not take effect ifSageMakerImageVersionArn
already exists in theResourceSpec
becauseSageMakerImageVersionArn
always takes precedence. To clear the value set forSageMakerImageVersionArn
, passNone
as the value.Type: ResourceSpec object
Required: No
- LifecycleConfigArns
-
The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.
Type: Array of strings
Length Constraints: Maximum length of 256.
Pattern:
^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: