Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. AppImageConfig
aws logo
AWS Classic v5.41.0, May 15 23

aws.sagemaker.AppImageConfig

Explore with Pulumi AI

Provides a SageMaker App Image Config resource.

Example Usage

Basic usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Sagemaker.AppImageConfig("test", new()
    {
        AppImageConfigName = "example",
        KernelGatewayImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs
        {
            KernelSpec = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs
            {
                Name = "example",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewAppImageConfig(ctx, "test", &sagemaker.AppImageConfigArgs{
			AppImageConfigName: pulumi.String("example"),
			KernelGatewayImageConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigArgs{
				KernelSpec: &sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs{
					Name: pulumi.String("example"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.AppImageConfig;
import com.pulumi.aws.sagemaker.AppImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new AppImageConfig("test", AppImageConfigArgs.builder()        
            .appImageConfigName("example")
            .kernelGatewayImageConfig(AppImageConfigKernelGatewayImageConfigArgs.builder()
                .kernelSpec(AppImageConfigKernelGatewayImageConfigKernelSpecArgs.builder()
                    .name("example")
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.sagemaker.AppImageConfig("test",
    app_image_config_name="example",
    kernel_gateway_image_config=aws.sagemaker.AppImageConfigKernelGatewayImageConfigArgs(
        kernel_spec=aws.sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs(
            name="example",
        ),
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.sagemaker.AppImageConfig("test", {
    appImageConfigName: "example",
    kernelGatewayImageConfig: {
        kernelSpec: {
            name: "example",
        },
    },
});

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

Default File System Config

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Sagemaker.AppImageConfig("test", new()
    {
        AppImageConfigName = "example",
        KernelGatewayImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs
        {
            FileSystemConfig = null,
            KernelSpec = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs
            {
                Name = "example",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewAppImageConfig(ctx, "test", &sagemaker.AppImageConfigArgs{
			AppImageConfigName: pulumi.String("example"),
			KernelGatewayImageConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigArgs{
				FileSystemConfig: nil,
				KernelSpec: &sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs{
					Name: pulumi.String("example"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.AppImageConfig;
import com.pulumi.aws.sagemaker.AppImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new AppImageConfig("test", AppImageConfigArgs.builder()        
            .appImageConfigName("example")
            .kernelGatewayImageConfig(AppImageConfigKernelGatewayImageConfigArgs.builder()
                .fileSystemConfig()
                .kernelSpec(AppImageConfigKernelGatewayImageConfigKernelSpecArgs.builder()
                    .name("example")
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.sagemaker.AppImageConfig("test",
    app_image_config_name="example",
    kernel_gateway_image_config=aws.sagemaker.AppImageConfigKernelGatewayImageConfigArgs(
        file_system_config=aws.sagemaker.AppImageConfigKernelGatewayImageConfigFileSystemConfigArgs(),
        kernel_spec=aws.sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs(
            name="example",
        ),
    ))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.sagemaker.AppImageConfig("test", {
    appImageConfigName: "example",
    kernelGatewayImageConfig: {
        fileSystemConfig: {},
        kernelSpec: {
            name: "example",
        },
    },
});

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

Create AppImageConfig Resource

new AppImageConfig(name: string, args: AppImageConfigArgs, opts?: CustomResourceOptions);
@overload
def AppImageConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   app_image_config_name: Optional[str] = None,
                   kernel_gateway_image_config: Optional[AppImageConfigKernelGatewayImageConfigArgs] = None,
                   tags: Optional[Mapping[str, str]] = None)
@overload
def AppImageConfig(resource_name: str,
                   args: AppImageConfigArgs,
                   opts: Optional[ResourceOptions] = 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.
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.

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

The AppImageConfig resource accepts the following input properties:

AppImageConfigName string

The name of the App Image Config.

KernelGatewayImageConfig Pulumi.Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs

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 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.

KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 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.

kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 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.

kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 {[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.

kernel_gateway_image_config AppImageConfigKernelGatewayImageConfigArgs

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 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.

kernelGatewayImageConfig Property Map

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 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.

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.

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.

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.

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.

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.

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,
        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)
Resource lookup is not supported in YAML
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.

KernelGatewayImageConfig Pulumi.Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs

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 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.

AppImageConfigName string

The name of the App Image Config.

Arn string

The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.

KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 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.

appImageConfigName String

The name of the App Image Config.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.

kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 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.

appImageConfigName string

The name of the App Image Config.

arn string

The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.

kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs

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 {[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.

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.

kernel_gateway_image_config AppImageConfigKernelGatewayImageConfigArgs

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 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.

appImageConfigName String

The name of the App Image Config.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.

kernelGatewayImageConfig Property Map

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 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.

Supporting Types

AppImageConfigKernelGatewayImageConfig

KernelSpec Pulumi.Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpec

The default branch for the Git repository. See Kernel Spec details below.

FileSystemConfig Pulumi.Aws.Sagemaker.Inputs.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

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.

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.

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.

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.

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.

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.

AppImageConfigKernelGatewayImageConfigKernelSpec

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

SageMaker App Image Configs can be imported using the name, e.g.,

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.