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	awscc.sagemaker.app_image_configs

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
app_image_config_name	string	The Name of the AppImageConfig.
region	string	AWS region.

For more information, see AWS::SageMaker::AppImageConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	app_image_configs	INSERT	AppImageConfigName, region
delete_resource	app_image_configs	DELETE	Identifier, region
update_resource	app_image_configs	UPDATE	Identifier, PatchDocument, region
list_resources	app_image_configs_list_only	SELECT	region
get_resource	app_image_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.sagemaker.app_image_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ app_image_config_name }}';

list (identifiers only)

Lists all app_image_configs in a region.

SELECT
  region,
  app_image_config_name
FROM awscc.sagemaker.app_image_configs_list_only
WHERE
  region = '{{ region }}';

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 awscc.sagemaker.app_image_configs (
  AppImageConfigName,
  region
)
SELECT
  '{{ app_image_config_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.app_image_configs (
  AppImageConfigName,
  KernelGatewayImageConfig,
  JupyterLabAppImageConfig,
  CodeEditorAppImageConfig,
  Tags,
  region
)
SELECT
  '{{ app_image_config_name }}',
  '{{ kernel_gateway_image_config }}',
  '{{ jupyter_lab_app_image_config }}',
  '{{ code_editor_app_image_config }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: app_image_config_name
      value: '{{ app_image_config_name }}'
    - name: kernel_gateway_image_config
      value:
        file_system_config:
          default_gid: '{{ default_gid }}'
          default_uid: '{{ default_uid }}'
          mount_path: '{{ mount_path }}'
        kernel_specs:
          - display_name: '{{ display_name }}'
            name: '{{ name }}'
    - name: jupyter_lab_app_image_config
      value:
        container_config:
          container_arguments:
            - '{{ container_arguments[0] }}'
          container_entrypoint:
            - '{{ container_entrypoint[0] }}'
          container_environment_variables:
            - value: '{{ value }}'
              key: '{{ key }}'
    - name: code_editor_app_image_config
      value:
        container_config: null
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.app_image_configs
SET PatchDocument = string('{{ {
    "KernelGatewayImageConfig": kernel_gateway_image_config,
    "JupyterLabAppImageConfig": jupyter_lab_app_image_config,
    "CodeEditorAppImageConfig": code_editor_app_image_config,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ app_image_config_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.app_image_configs
WHERE
  Identifier = '{{ app_image_config_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

sagemaker:CreateAppImageConfig,
sagemaker:DescribeAppImageConfig,
sagemaker:AddTags,
sagemaker:ListTags

Read

sagemaker:DescribeAppImageConfig,
sagemaker:ListTags

Update

sagemaker:UpdateAppImageConfig,
sagemaker:DescribeAppImageConfig,
sagemaker:AddTags,
sagemaker:DeleteTags,
sagemaker:ListTags

Delete

sagemaker:DeleteAppImageConfig,
sagemaker:DescribeAppImageConfig,
sagemaker:DeleteTags

List

sagemaker:ListAppImageConfigs,
sagemaker:ListTags