app_image_configs

Creates, updates, deletes or gets an app_image_config resource or lists app_image_configs in a region

Overview

Name	app_image_configs
Type	Resource
Description	Resource Type definition for AWS::SageMaker::AppImageConfig
Id	aws.sagemaker.app_image_configs

Fields

Name	Datatype	Description
app_image_config_arn	string	The Amazon Resource Name (ARN) of the AppImageConfig.
app_image_config_name	string	The Name of the AppImageConfig.
kernel_gateway_image_config	object	The KernelGatewayImageConfig.
jupyter_lab_app_image_config	object	The JupyterLabAppImageConfig.
code_editor_app_image_config	object	The CodeEditorAppImageConfig.
tags	array	A list of tags to apply to the AppImageConfig.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AppImageConfigName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all app_image_configs in a region.

SELECT
region,
app_image_config_arn,
app_image_config_name,
kernel_gateway_image_config,
jupyter_lab_app_image_config,
code_editor_app_image_config,
tags
FROM aws.sagemaker.app_image_configs
WHERE region = 'us-east-1';

Gets all properties from an individual app_image_config.

SELECT
region,
app_image_config_arn,
app_image_config_name,
kernel_gateway_image_config,
jupyter_lab_app_image_config,
code_editor_app_image_config,
tags
FROM aws.sagemaker.app_image_configs
WHERE region = 'us-east-1' AND data__Identifier = '<AppImageConfigName>';

INSERT example

Use the following StackQL query and manifest file to create a new app_image_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.app_image_configs (
 AppImageConfigName,
 region
)
SELECT 
'{{ AppImageConfigName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.app_image_configs (
 AppImageConfigName,
 KernelGatewayImageConfig,
 JupyterLabAppImageConfig,
 CodeEditorAppImageConfig,
 Tags,
 region
)
SELECT 
 '{{ AppImageConfigName }}',
 '{{ KernelGatewayImageConfig }}',
 '{{ JupyterLabAppImageConfig }}',
 '{{ CodeEditorAppImageConfig }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: app_image_config
    props:
      - name: AppImageConfigName
        value: '{{ AppImageConfigName }}'
      - name: KernelGatewayImageConfig
        value:
          FileSystemConfig:
            DefaultGid: '{{ DefaultGid }}'
            DefaultUid: '{{ DefaultUid }}'
            MountPath: '{{ MountPath }}'
          KernelSpecs:
            - DisplayName: '{{ DisplayName }}'
              Name: '{{ Name }}'
      - name: JupyterLabAppImageConfig
        value:
          ContainerConfig:
            ContainerArguments:
              - '{{ ContainerArguments[0] }}'
            ContainerEntrypoint:
              - '{{ ContainerEntrypoint[0] }}'
            ContainerEnvironmentVariables:
              - Value: '{{ Value }}'
                Key: '{{ Key }}'
      - name: CodeEditorAppImageConfig
        value:
          ContainerConfig: null
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.app_image_configs
WHERE data__Identifier = '<AppImageConfigName>'
AND region = 'us-east-1';

Permissions

To operate on the app_image_configs resource, the following permissions are required:

Create

sagemaker:CreateAppImageConfig,
sagemaker:DescribeAppImageConfig

Read

sagemaker:DescribeAppImageConfig

Update

sagemaker:UpdateAppImageConfig,
sagemaker:DescribeAppImageConfig

Delete

sagemaker:DeleteAppImageConfig,
sagemaker:DescribeAppImageConfig

List

sagemaker:ListAppImageConfigs