AWS::SageMaker::AppImageConfig
Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SageMaker::AppImageConfig", "Properties" : { "AppImageConfigName" :
String
, "CodeEditorAppImageConfig" :CodeEditorAppImageConfig
, "JupyterLabAppImageConfig" :JupyterLabAppImageConfig
, "KernelGatewayImageConfig" :KernelGatewayImageConfig
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::SageMaker::AppImageConfig Properties: AppImageConfigName:
String
CodeEditorAppImageConfig:CodeEditorAppImageConfig
JupyterLabAppImageConfig:JupyterLabAppImageConfig
KernelGatewayImageConfig:KernelGatewayImageConfig
Tags:- Tag
Properties
AppImageConfigName
-
The name of the AppImageConfig. Must be unique to your account.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Minimum:
1
Maximum:
63
Update requires: Replacement
CodeEditorAppImageConfig
-
The configuration for the file system and the runtime, such as the environment variables and entry point.
Required: No
Type: CodeEditorAppImageConfig
Update requires: No interruption
JupyterLabAppImageConfig
-
The configuration for the file system and the runtime, such as the environment variables and entry point.
Required: No
Type: JupyterLabAppImageConfig
Update requires: No interruption
KernelGatewayImageConfig
-
The configuration for the file system and kernels in the SageMaker image.
Required: No
Type: KernelGatewayImageConfig
Update requires: No interruption
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Minimum:
0
Maximum:
50
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the name of the AppImageConfig.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
AppImageConfigArn
-
The Amazon Resource Name (ARN) of the AppImageConfig, such as
arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name
.