Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. AppImageConfig
AWS v6.81.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.AppImageConfig

Explore with Pulumi AI

aws logo
AWS v6.81.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker AI App Image Config resource.

    Example Usage

    Basic usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  test:
    type: aws:sagemaker:AppImageConfig
    properties:
      appImageConfigName: example
      kernelGatewayImageConfig:
        kernelSpecs:
          - name: example

    Default File System Config

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  test:
    type: aws:sagemaker:AppImageConfig
    properties:
      appImageConfigName: example
      kernelGatewayImageConfig:
        kernelSpecs:
          - name: example
        fileSystemConfig: {}

    Create AppImageConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AppImageConfig(name: string, args: AppImageConfigArgs, opts?: CustomResourceOptions);
    @overload
def AppImageConfig(resource_name: str,
                   args: AppImageConfigArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def AppImageConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   app_image_config_name: Optional[str] = None,
                   code_editor_app_image_config: Optional[AppImageConfigCodeEditorAppImageConfigArgs] = None,
                   jupyter_lab_image_config: Optional[AppImageConfigJupyterLabImageConfigArgs] = None,
                   kernel_gateway_image_config: Optional[AppImageConfigKernelGatewayImageConfigArgs] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewAppImageConfig(ctx *Context, name string, args AppImageConfigArgs, opts ...ResourceOption) (*AppImageConfig, error)
    public AppImageConfig(string name, AppImageConfigArgs args, CustomResourceOptions? opts = null)
    public AppImageConfig(String name, AppImageConfigArgs args)
public AppImageConfig(String name, AppImageConfigArgs args, CustomResourceOptions options)

    type: aws:sagemaker:AppImageConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var appImageConfigResource = new Aws.Sagemaker.AppImageConfig("appImageConfigResource", new()
{
    AppImageConfigName = "string",
    CodeEditorAppImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigCodeEditorAppImageConfigArgs
    {
        ContainerConfig = new Aws.Sagemaker.Inputs.AppImageConfigCodeEditorAppImageConfigContainerConfigArgs
        {
            ContainerArguments = new[]
            {
                "string",
            },
            ContainerEntrypoints = new[]
            {
                "string",
            },
            ContainerEnvironmentVariables = 
            {
                { "string", "string" },
            },
        },
        FileSystemConfig = new Aws.Sagemaker.Inputs.AppImageConfigCodeEditorAppImageConfigFileSystemConfigArgs
        {
            DefaultGid = 0,
            DefaultUid = 0,
            MountPath = "string",
        },
    },
    JupyterLabImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigJupyterLabImageConfigArgs
    {
        ContainerConfig = new Aws.Sagemaker.Inputs.AppImageConfigJupyterLabImageConfigContainerConfigArgs
        {
            ContainerArguments = new[]
            {
                "string",
            },
            ContainerEntrypoints = new[]
            {
                "string",
            },
            ContainerEnvironmentVariables = 
            {
                { "string", "string" },
            },
        },
        FileSystemConfig = new Aws.Sagemaker.Inputs.AppImageConfigJupyterLabImageConfigFileSystemConfigArgs
        {
            DefaultGid = 0,
            DefaultUid = 0,
            MountPath = "string",
        },
    },
    KernelGatewayImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs
    {
        KernelSpec = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs
        {
            Name = "string",
            DisplayName = "string",
        },
        FileSystemConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs
        {
            DefaultGid = 0,
            DefaultUid = 0,
            MountPath = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sagemaker.NewAppImageConfig(ctx, "appImageConfigResource", &sagemaker.AppImageConfigArgs{
	AppImageConfigName: pulumi.String("string"),
	CodeEditorAppImageConfig: &sagemaker.AppImageConfigCodeEditorAppImageConfigArgs{
		ContainerConfig: &sagemaker.AppImageConfigCodeEditorAppImageConfigContainerConfigArgs{
			ContainerArguments: pulumi.StringArray{
				pulumi.String("string"),
			},
			ContainerEntrypoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			ContainerEnvironmentVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		FileSystemConfig: &sagemaker.AppImageConfigCodeEditorAppImageConfigFileSystemConfigArgs{
			DefaultGid: pulumi.Int(0),
			DefaultUid: pulumi.Int(0),
			MountPath:  pulumi.String("string"),
		},
	},
	JupyterLabImageConfig: &sagemaker.AppImageConfigJupyterLabImageConfigArgs{
		ContainerConfig: &sagemaker.AppImageConfigJupyterLabImageConfigContainerConfigArgs{
			ContainerArguments: pulumi.StringArray{
				pulumi.String("string"),
			},
			ContainerEntrypoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			ContainerEnvironmentVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		FileSystemConfig: &sagemaker.AppImageConfigJupyterLabImageConfigFileSystemConfigArgs{
			DefaultGid: pulumi.Int(0),
			DefaultUid: pulumi.Int(0),
			MountPath:  pulumi.String("string"),
		},
	},
	KernelGatewayImageConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigArgs{
		KernelSpec: &sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs{
			Name:        pulumi.String("string"),
			DisplayName: pulumi.String("string"),
		},
		FileSystemConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs{
			DefaultGid: pulumi.Int(0),
			DefaultUid: pulumi.Int(0),
			MountPath:  pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var appImageConfigResource = new AppImageConfig("appImageConfigResource", AppImageConfigArgs.builder()
    .appImageConfigName("string")
    .codeEditorAppImageConfig(AppImageConfigCodeEditorAppImageConfigArgs.builder()
        .containerConfig(AppImageConfigCodeEditorAppImageConfigContainerConfigArgs.builder()
            .containerArguments("string")
            .containerEntrypoints("string")
            .containerEnvironmentVariables(Map.of("string", "string"))
            .build())
        .fileSystemConfig(AppImageConfigCodeEditorAppImageConfigFileSystemConfigArgs.builder()
            .defaultGid(0)
            .defaultUid(0)
            .mountPath("string")
            .build())
        .build())
    .jupyterLabImageConfig(AppImageConfigJupyterLabImageConfigArgs.builder()
        .containerConfig(AppImageConfigJupyterLabImageConfigContainerConfigArgs.builder()
            .containerArguments("string")
            .containerEntrypoints("string")
            .containerEnvironmentVariables(Map.of("string", "string"))
            .build())
        .fileSystemConfig(AppImageConfigJupyterLabImageConfigFileSystemConfigArgs.builder()
            .defaultGid(0)
            .defaultUid(0)
            .mountPath("string")
            .build())
        .build())
    .kernelGatewayImageConfig(AppImageConfigKernelGatewayImageConfigArgs.builder()
        .kernelSpec(AppImageConfigKernelGatewayImageConfigKernelSpecArgs.builder()
            .name("string")
            .displayName("string")
            .build())
        .fileSystemConfig(AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs.builder()
            .defaultGid(0)
            .defaultUid(0)
            .mountPath("string")
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .build());

    app_image_config_resource = aws.sagemaker.AppImageConfig("appImageConfigResource",
    app_image_config_name="string",
    code_editor_app_image_config={
        "container_config": {
            "container_arguments": ["string"],
            "container_entrypoints": ["string"],
            "container_environment_variables": {
                "string": "string",
            },
        },
        "file_system_config": {
            "default_gid": 0,
            "default_uid": 0,
            "mount_path": "string",
        },
    },
    jupyter_lab_image_config={
        "container_config": {
            "container_arguments": ["string"],
            "container_entrypoints": ["string"],
            "container_environment_variables": {
                "string": "string",
            },
        },
        "file_system_config": {
            "default_gid": 0,
            "default_uid": 0,
            "mount_path": "string",
        },
    },
    kernel_gateway_image_config={
        "kernel_spec": {
            "name": "string",
            "display_name": "string",
        },
        "file_system_config": {
            "default_gid": 0,
            "default_uid": 0,
            "mount_path": "string",
        },
    },
    tags={
        "string": "string",
    })

    const appImageConfigResource = new aws.sagemaker.AppImageConfig("appImageConfigResource", {
    appImageConfigName: "string",
    codeEditorAppImageConfig: {
        containerConfig: {
            containerArguments: ["string"],
            containerEntrypoints: ["string"],
            containerEnvironmentVariables: {
                string: "string",
            },
        },
        fileSystemConfig: {
            defaultGid: 0,
            defaultUid: 0,
            mountPath: "string",
        },
    },
    jupyterLabImageConfig: {
        containerConfig: {
            containerArguments: ["string"],
            containerEntrypoints: ["string"],
            containerEnvironmentVariables: {
                string: "string",
            },
        },
        fileSystemConfig: {
            defaultGid: 0,
            defaultUid: 0,
            mountPath: "string",
        },
    },
    kernelGatewayImageConfig: {
        kernelSpec: {
            name: "string",
            displayName: "string",
        },
        fileSystemConfig: {
            defaultGid: 0,
            defaultUid: 0,
            mountPath: "string",
        },
    },
    tags: {
        string: "string",
    },
});

    type: aws:sagemaker:AppImageConfig
properties:
    appImageConfigName: string
    codeEditorAppImageConfig:
        containerConfig:
            containerArguments:
                - string
            containerEntrypoints:
                - string
            containerEnvironmentVariables:
                string: string
        fileSystemConfig:
            defaultGid: 0
            defaultUid: 0
            mountPath: string
    jupyterLabImageConfig:
        containerConfig:
            containerArguments:
                - string
            containerEntrypoints:
                - string
            containerEnvironmentVariables:
                string: string
        fileSystemConfig:
            defaultGid: 0
            defaultUid: 0
            mountPath: string
    kernelGatewayImageConfig:
        fileSystemConfig:
            defaultGid: 0
            defaultUid: 0
            mountPath: string
        kernelSpec:
            displayName: string
            name: string
    tags:
        string: string

    AppImageConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AppImageConfig resource accepts the following input properties:

    AppImageConfigName string
    The name of the App Image Config.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    JupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    Tags Dictionary<string, string>
    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.
    AppImageConfigName string
    The name of the App Image Config.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfigArgs
    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.
    JupyterLabImageConfig AppImageConfigJupyterLabImageConfigArgs
    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.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    Tags map[string]string
    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.
    appImageConfigName String
    The name of the App Image Config.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    jupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Map<String,String>
    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.
    appImageConfigName string
    The name of the App Image Config.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    jupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags {[key: string]: string}
    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.
    app_image_config_name str
    The name of the App Image Config.
    code_editor_app_image_config AppImageConfigCodeEditorAppImageConfigArgs
    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 AppImageConfigJupyterLabImageConfigArgs
    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 AppImageConfigKernelGatewayImageConfigArgs
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Mapping[str, str]
    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.
    appImageConfigName String
    The name of the App Image Config.
    codeEditorAppImageConfig Property Map
    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.
    jupyterLabImageConfig Property Map
    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.
    kernelGatewayImageConfig Property Map
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AppImageConfig resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing AppImageConfig Resource

    Get an existing AppImageConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AppImageConfigState, opts?: CustomResourceOptions): AppImageConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_image_config_name: Optional[str] = None,
        arn: Optional[str] = None,
        code_editor_app_image_config: Optional[AppImageConfigCodeEditorAppImageConfigArgs] = None,
        jupyter_lab_image_config: Optional[AppImageConfigJupyterLabImageConfigArgs] = None,
        kernel_gateway_image_config: Optional[AppImageConfigKernelGatewayImageConfigArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> AppImageConfig
    func GetAppImageConfig(ctx *Context, name string, id IDInput, state *AppImageConfigState, opts ...ResourceOption) (*AppImageConfig, error)
    public static AppImageConfig Get(string name, Input<string> id, AppImageConfigState? state, CustomResourceOptions? opts = null)
    public static AppImageConfig get(String name, Output<String> id, AppImageConfigState state, CustomResourceOptions options)
    resources:  _:    type: aws:sagemaker:AppImageConfig    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppImageConfigName string
    The name of the App Image Config.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    JupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AppImageConfigName string
    The name of the App Image Config.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfigArgs
    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.
    JupyterLabImageConfig AppImageConfigJupyterLabImageConfigArgs
    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.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appImageConfigName String
    The name of the App Image Config.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    jupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appImageConfigName string
    The name of the App Image Config.
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    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.
    jupyterLabImageConfig AppImageConfigJupyterLabImageConfig
    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.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    app_image_config_name str
    The name of the App Image Config.
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    code_editor_app_image_config AppImageConfigCodeEditorAppImageConfigArgs
    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 AppImageConfigJupyterLabImageConfigArgs
    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 AppImageConfigKernelGatewayImageConfigArgs
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    appImageConfigName String
    The name of the App Image Config.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
    codeEditorAppImageConfig Property Map
    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.
    jupyterLabImageConfig Property Map
    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.
    kernelGatewayImageConfig Property Map
    The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    AppImageConfigCodeEditorAppImageConfig, AppImageConfigCodeEditorAppImageConfigArgs

    ContainerConfig AppImageConfigCodeEditorAppImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    FileSystemConfig AppImageConfigCodeEditorAppImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    ContainerConfig AppImageConfigCodeEditorAppImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    FileSystemConfig AppImageConfigCodeEditorAppImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig AppImageConfigCodeEditorAppImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig AppImageConfigCodeEditorAppImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig AppImageConfigCodeEditorAppImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig AppImageConfigCodeEditorAppImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    container_config AppImageConfigCodeEditorAppImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    file_system_config AppImageConfigCodeEditorAppImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig Property Map
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig Property Map
    The URL where the Git repository is located. See File System Config details below.

    AppImageConfigCodeEditorAppImageConfigContainerConfig, AppImageConfigCodeEditorAppImageConfigContainerConfigArgs

    ContainerArguments List<string>
    The arguments for the container when you're running the application.
    ContainerEntrypoints List<string>
    The entrypoint used to run the application in the container.
    ContainerEnvironmentVariables Dictionary<string, string>
    The environment variables to set in the container.
    ContainerArguments []string
    The arguments for the container when you're running the application.
    ContainerEntrypoints []string
    The entrypoint used to run the application in the container.
    ContainerEnvironmentVariables map[string]string
    The environment variables to set in the container.
    containerArguments List<String>
    The arguments for the container when you're running the application.
    containerEntrypoints List<String>
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables Map<String,String>
    The environment variables to set in the container.
    containerArguments string[]
    The arguments for the container when you're running the application.
    containerEntrypoints string[]
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables {[key: string]: string}
    The environment variables to set in the container.
    container_arguments Sequence[str]
    The arguments for the container when you're running the application.
    container_entrypoints Sequence[str]
    The entrypoint used to run the application in the container.
    container_environment_variables Mapping[str, str]
    The environment variables to set in the container.
    containerArguments List<String>
    The arguments for the container when you're running the application.
    containerEntrypoints List<String>
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables Map<String>
    The environment variables to set in the container.

    AppImageConfigCodeEditorAppImageConfigFileSystemConfig, AppImageConfigCodeEditorAppImageConfigFileSystemConfigArgs

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Integer
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Integer
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    default_gid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    default_uid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mount_path str

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    AppImageConfigJupyterLabImageConfig, AppImageConfigJupyterLabImageConfigArgs

    ContainerConfig AppImageConfigJupyterLabImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    FileSystemConfig AppImageConfigJupyterLabImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    ContainerConfig AppImageConfigJupyterLabImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    FileSystemConfig AppImageConfigJupyterLabImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig AppImageConfigJupyterLabImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig AppImageConfigJupyterLabImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig AppImageConfigJupyterLabImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig AppImageConfigJupyterLabImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    container_config AppImageConfigJupyterLabImageConfigContainerConfig
    The configuration used to run the application image container. See Container Config details below.
    file_system_config AppImageConfigJupyterLabImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    containerConfig Property Map
    The configuration used to run the application image container. See Container Config details below.
    fileSystemConfig Property Map
    The URL where the Git repository is located. See File System Config details below.

    AppImageConfigJupyterLabImageConfigContainerConfig, AppImageConfigJupyterLabImageConfigContainerConfigArgs

    ContainerArguments List<string>
    The arguments for the container when you're running the application.
    ContainerEntrypoints List<string>
    The entrypoint used to run the application in the container.
    ContainerEnvironmentVariables Dictionary<string, string>
    The environment variables to set in the container.
    ContainerArguments []string
    The arguments for the container when you're running the application.
    ContainerEntrypoints []string
    The entrypoint used to run the application in the container.
    ContainerEnvironmentVariables map[string]string
    The environment variables to set in the container.
    containerArguments List<String>
    The arguments for the container when you're running the application.
    containerEntrypoints List<String>
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables Map<String,String>
    The environment variables to set in the container.
    containerArguments string[]
    The arguments for the container when you're running the application.
    containerEntrypoints string[]
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables {[key: string]: string}
    The environment variables to set in the container.
    container_arguments Sequence[str]
    The arguments for the container when you're running the application.
    container_entrypoints Sequence[str]
    The entrypoint used to run the application in the container.
    container_environment_variables Mapping[str, str]
    The environment variables to set in the container.
    containerArguments List<String>
    The arguments for the container when you're running the application.
    containerEntrypoints List<String>
    The entrypoint used to run the application in the container.
    containerEnvironmentVariables Map<String>
    The environment variables to set in the container.

    AppImageConfigJupyterLabImageConfigFileSystemConfig, AppImageConfigJupyterLabImageConfigFileSystemConfigArgs

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Integer
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Integer
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    default_gid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    default_uid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mount_path str

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    AppImageConfigKernelGatewayImageConfig, AppImageConfigKernelGatewayImageConfigArgs

    KernelSpec AppImageConfigKernelGatewayImageConfigKernelSpec
    The default branch for the Git repository. See Kernel Spec details below.
    FileSystemConfig AppImageConfigKernelGatewayImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    KernelSpec AppImageConfigKernelGatewayImageConfigKernelSpec
    The default branch for the Git repository. See Kernel Spec details below.
    FileSystemConfig AppImageConfigKernelGatewayImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    kernelSpec AppImageConfigKernelGatewayImageConfigKernelSpec
    The default branch for the Git repository. See Kernel Spec details below.
    fileSystemConfig AppImageConfigKernelGatewayImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    kernelSpec AppImageConfigKernelGatewayImageConfigKernelSpec
    The default branch for the Git repository. See Kernel Spec details below.
    fileSystemConfig AppImageConfigKernelGatewayImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    kernel_spec AppImageConfigKernelGatewayImageConfigKernelSpec
    The default branch for the Git repository. See Kernel Spec details below.
    file_system_config AppImageConfigKernelGatewayImageConfigFileSystemConfig
    The URL where the Git repository is located. See File System Config details below.
    kernelSpec Property Map
    The default branch for the Git repository. See Kernel Spec details below.
    fileSystemConfig Property Map
    The URL where the Git repository is located. See File System Config details below.

    AppImageConfigKernelGatewayImageConfigFileSystemConfig, AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    MountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Integer
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Integer
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath string

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    default_gid int
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    default_uid int
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mount_path str

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    defaultGid Number
    The default POSIX group ID (GID). If not specified, defaults to 100. Valid values are 0 and 100.
    defaultUid Number
    The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are 0 and 1000.
    mountPath String

    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.

    Note: When specifying default_gid and default_uid, Valid value pairs are [0, 0] and [100, 1000].

    AppImageConfigKernelGatewayImageConfigKernelSpec, AppImageConfigKernelGatewayImageConfigKernelSpecArgs

    Name string
    The name of the kernel.
    DisplayName string
    The display name of the kernel.
    Name string
    The name of the kernel.
    DisplayName string
    The display name of the kernel.
    name String
    The name of the kernel.
    displayName String
    The display name of the kernel.
    name string
    The name of the kernel.
    displayName string
    The display name of the kernel.
    name str
    The name of the kernel.
    display_name str
    The display name of the kernel.
    name String
    The name of the kernel.
    displayName String
    The display name of the kernel.

    Import

    Using pulumi import, import SageMaker AI App Image Configs using the name. For example:

    $ pulumi import aws:sagemaker/appImageConfig:AppImageConfig example example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.81.0 published on Tuesday, May 20, 2025 by Pulumi
    pulumi/pulumi-aws