aws.sagemaker.AppImageConfig
Explore with Pulumi AI
Provides a SageMaker AI App Image Config resource.
Example Usage
Basic usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
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 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()
                .kernelSpecs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());
    }
}
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!
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 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()
                .kernelSpecs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .fileSystemConfig()
                .build())
            .build());
    }
}
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:
- AppImage stringConfig Name 
- The name of the App Image Config.
- CodeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- JupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- KernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- AppImage stringConfig Name 
- The name of the App Image Config.
- CodeEditor AppApp Image Config Image Config Code Editor App Image Config Args 
- 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.
- JupyterLab AppImage Config Image Config Jupyter Lab Image Config Args 
- 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.
- KernelGateway AppImage Config Image Config Kernel Gateway Image Config Args 
- 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.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- appImage StringConfig Name 
- The name of the App Image Config.
- codeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- jupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- kernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- appImage stringConfig Name 
- The name of the App Image Config.
- codeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- jupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- kernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- app_image_ strconfig_ name 
- The name of the App Image Config.
- code_editor_ Appapp_ image_ config Image Config Code Editor App Image Config Args 
- 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_ Appimage_ config Image Config Jupyter Lab Image Config Args 
- 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_ Appimage_ config Image Config Kernel Gateway Image Config Args 
- 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.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- appImage StringConfig Name 
- The name of the App Image Config.
- codeEditor Property MapApp Image Config 
- 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.
- jupyterLab Property MapImage Config 
- 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.
- kernelGateway Property MapImage Config 
- 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.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration 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:
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) -> AppImageConfigfunc 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.
- AppImage stringConfig Name 
- The name of the App Image Config.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- CodeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- JupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- KernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- AppImage stringConfig Name 
- The name of the App Image Config.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- CodeEditor AppApp Image Config Image Config Code Editor App Image Config Args 
- 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.
- JupyterLab AppImage Config Image Config Jupyter Lab Image Config Args 
- 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.
- KernelGateway AppImage Config Image Config Kernel Gateway Image Config Args 
- 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.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- appImage StringConfig Name 
- The name of the App Image Config.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- codeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- jupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- kernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- appImage stringConfig Name 
- The name of the App Image Config.
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- codeEditor AppApp Image Config Image Config Code Editor App Image Config 
- 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.
- jupyterLab AppImage Config Image Config Jupyter Lab Image Config 
- 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.
- kernelGateway AppImage Config Image Config Kernel Gateway Image Config 
- 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.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- app_image_ strconfig_ name 
- The name of the App Image Config.
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- code_editor_ Appapp_ image_ config Image Config Code Editor App Image Config Args 
- 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_ Appimage_ config Image Config Jupyter Lab Image Config Args 
- 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_ Appimage_ config Image Config Kernel Gateway Image Config Args 
- 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.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- appImage StringConfig Name 
- The name of the App Image Config.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
- codeEditor Property MapApp Image Config 
- 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.
- jupyterLab Property MapImage Config 
- 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.
- kernelGateway Property MapImage Config 
- 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.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
Supporting Types
AppImageConfigCodeEditorAppImageConfig, AppImageConfigCodeEditorAppImageConfigArgs                
- ContainerConfig AppImage Config Code Editor App Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- FileSystem AppConfig Image Config Code Editor App Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- ContainerConfig AppImage Config Code Editor App Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- FileSystem AppConfig Image Config Code Editor App Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- containerConfig AppImage Config Code Editor App Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- fileSystem AppConfig Image Config Code Editor App Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- containerConfig AppImage Config Code Editor App Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- fileSystem AppConfig Image Config Code Editor App Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- container_config AppImage Config Code Editor App Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- file_system_ Appconfig Image Config Code Editor App Image Config File System Config 
- 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.
- fileSystem Property MapConfig 
- 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.
- ContainerEnvironment Dictionary<string, string>Variables 
- 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.
- ContainerEnvironment map[string]stringVariables 
- 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.
- containerEnvironment Map<String,String>Variables 
- 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.
- containerEnvironment {[key: string]: string}Variables 
- 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_ Mapping[str, str]variables 
- 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.
- containerEnvironment Map<String>Variables 
- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Integer
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- default_uid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- default_uid, Valid value pairs are [- 0,- 0] and [- 100,- 1000].
AppImageConfigJupyterLabImageConfig, AppImageConfigJupyterLabImageConfigArgs              
- ContainerConfig AppImage Config Jupyter Lab Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- FileSystem AppConfig Image Config Jupyter Lab Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- ContainerConfig AppImage Config Jupyter Lab Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- FileSystem AppConfig Image Config Jupyter Lab Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- containerConfig AppImage Config Jupyter Lab Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- fileSystem AppConfig Image Config Jupyter Lab Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- containerConfig AppImage Config Jupyter Lab Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- fileSystem AppConfig Image Config Jupyter Lab Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- container_config AppImage Config Jupyter Lab Image Config Container Config 
- The configuration used to run the application image container. See Container Config details below.
- file_system_ Appconfig Image Config Jupyter Lab Image Config File System Config 
- 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.
- fileSystem Property MapConfig 
- 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.
- ContainerEnvironment Dictionary<string, string>Variables 
- 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.
- ContainerEnvironment map[string]stringVariables 
- 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.
- containerEnvironment Map<String,String>Variables 
- 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.
- containerEnvironment {[key: string]: string}Variables 
- 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_ Mapping[str, str]variables 
- 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.
- containerEnvironment Map<String>Variables 
- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Integer
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- default_uid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- default_uid, Valid value pairs are [- 0,- 0] and [- 100,- 1000].
AppImageConfigKernelGatewayImageConfig, AppImageConfigKernelGatewayImageConfigArgs              
- KernelSpec AppImage Config Kernel Gateway Image Config Kernel Spec 
- The default branch for the Git repository. See Kernel Spec details below.
- FileSystem AppConfig Image Config Kernel Gateway Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- KernelSpec AppImage Config Kernel Gateway Image Config Kernel Spec 
- The default branch for the Git repository. See Kernel Spec details below.
- FileSystem AppConfig Image Config Kernel Gateway Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- kernelSpec AppImage Config Kernel Gateway Image Config Kernel Spec 
- The default branch for the Git repository. See Kernel Spec details below.
- fileSystem AppConfig Image Config Kernel Gateway Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- kernelSpec AppImage Config Kernel Gateway Image Config Kernel Spec 
- The default branch for the Git repository. See Kernel Spec details below.
- fileSystem AppConfig Image Config Kernel Gateway Image Config File System Config 
- The URL where the Git repository is located. See File System Config details below.
- kernel_spec AppImage Config Kernel Gateway Image Config Kernel Spec 
- The default branch for the Git repository. See Kernel Spec details below.
- file_system_ Appconfig Image Config Kernel Gateway Image Config File System Config 
- 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.
- fileSystem Property MapConfig 
- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- DefaultUid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Integer
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- default_uid int
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 are0and100.
- defaultUid Number
- The default POSIX user ID (UID). If not specified, defaults to 1000. Valid values are0and1000.
- 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_gidand- 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 awsTerraform Provider.