Provides a SageMaker App Image Config resource.
resource "aws_sagemaker_app_image_config" "test" {
app_image_config_name = "example"
kernel_gateway_image_config {
kernel_spec {
name = "example"
}
}
}
resource "aws_sagemaker_app_image_config" "test" {
app_image_config_name = "example"
kernel_gateway_image_config {
kernel_spec {
name = "example"
}
file_system_config {}
}
}
This resource supports the following arguments:
app_image_config_name
- (Required) The name of the App Image Config.code_editor_app_image_config
- (Optional) The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor. See Code Editor App Image Config details below.jupyter_lab_image_config
- (Optional) The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab. See Jupyter Lab Image Config details below.kernel_gateway_image_config
- (Optional) The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app. See Kernel Gateway Image Config details below.tags
- (Optional) A map of tags to assign to the resource. If configured with a provider default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.container_config
- (Optional) The configuration used to run the application image container. See Container Config details below.file_system_config
- (Optional) The URL where the Git repository is located. See File System Config details below.container_config
- (Optional) The configuration used to run the application image container. See Container Config details below.file_system_config
- (Optional) The URL where the Git repository is located. See File System Config details below.container_arguments
- (Optional) The arguments for the container when you're running the application.container_entrypoint
- (Optional) The entrypoint used to run the application in the container.container_environment_variables
- (Optional) The environment variables to set in the container.file_system_config
- (Optional) The URL where the Git repository is located. See File System Config details below.kernel_spec
- (Required) The default branch for the Git repository. See Kernel Spec details below.default_gid
- (Optional) The default POSIX group ID (GID). If not specified, defaults to 100
. Valid values are 0
and 100
.default_uid
- (Optional) The default POSIX user ID (UID). If not specified, defaults to 1000
. Valid values are 0
and 1000
.mount_path
- (Optional) The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user
.name
- (Required) The name of the kernel.display_name
- (Optional) The display name of the kernel.This resource exports the following attributes in addition to the arguments above:
id
- The name of the App Image Config.arn
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.tags_all
- A map of tags assigned to the resource, including those inherited from the provider default_tags
configuration block.In Terraform v1.5.0 and later, use an import
block to import SageMaker App Image Configs using the name
. For example:
import {
to = aws_sagemaker_app_image_config.example
id = "example"
}
Using terraform import
, import SageMaker App Image Configs using the name
. For example:
% terraform import aws_sagemaker_app_image_config.example example