Skip to content
v2.277.0

CfnAppImageConfigProps Struct ​

Properties for defining a CfnAppImageConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnAppImageConfigProps: sagemaker.CfnAppImageConfigProps = {
  appImageConfigName: 'appImageConfigName',

  // the properties below are optional
  codeEditorAppImageConfig: {
    containerConfig: {
      containerArguments: ['containerArguments'],
      containerEntrypoint: ['containerEntrypoint'],
      containerEnvironmentVariables: [{
        key: 'key',
        value: 'value',
      }],
    },
  },
  jupyterLabAppImageConfig: {
    containerConfig: {
      containerArguments: ['containerArguments'],
      containerEntrypoint: ['containerEntrypoint'],
      containerEnvironmentVariables: [{
        key: 'key',
        value: 'value',
      }],
    },
  },
  kernelGatewayImageConfig: {
    kernelSpecs: [{
      name: 'name',

      // the properties below are optional
      displayName: 'displayName',
    }],

    // the properties below are optional
    fileSystemConfig: {
      defaultGid: 123,
      defaultUid: 123,
      mountPath: 'mountPath',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_app_image_config_props = sagemaker.CfnAppImageConfigProps(
    app_image_config_name="appImageConfigName",

    # the properties below are optional
    code_editor_app_image_config=sagemaker.CfnAppImageConfig.CodeEditorAppImageConfigProperty(
        container_config=sagemaker.CfnAppImageConfig.ContainerConfigProperty(
            container_arguments=["containerArguments"],
            container_entrypoint=["containerEntrypoint"],
            container_environment_variables=[sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
                key="key",
                value="value"
            )]
        )
    ),
    jupyter_lab_app_image_config=sagemaker.CfnAppImageConfig.JupyterLabAppImageConfigProperty(
        container_config=sagemaker.CfnAppImageConfig.ContainerConfigProperty(
            container_arguments=["containerArguments"],
            container_entrypoint=["containerEntrypoint"],
            container_environment_variables=[sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
                key="key",
                value="value"
            )]
        )
    ),
    kernel_gateway_image_config=sagemaker.CfnAppImageConfig.KernelGatewayImageConfigProperty(
        kernel_specs=[sagemaker.CfnAppImageConfig.KernelSpecProperty(
            name="name",

            # the properties below are optional
            display_name="displayName"
        )],

        # the properties below are optional
        file_system_config=sagemaker.CfnAppImageConfig.FileSystemConfigProperty(
            default_gid=123,
            default_uid=123,
            mount_path="mountPath"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

CfnAppImageConfigProps cfnAppImageConfigProps = CfnAppImageConfigProps.builder()
        .appImageConfigName("appImageConfigName")

        // the properties below are optional
        .codeEditorAppImageConfig(CodeEditorAppImageConfigProperty.builder()
                .containerConfig(ContainerConfigProperty.builder()
                        .containerArguments(List.of("containerArguments"))
                        .containerEntrypoint(List.of("containerEntrypoint"))
                        .containerEnvironmentVariables(List.of(CustomImageContainerEnvironmentVariableProperty.builder()
                                .key("key")
                                .value("value")
                                .build()))
                        .build())
                .build())
        .jupyterLabAppImageConfig(JupyterLabAppImageConfigProperty.builder()
                .containerConfig(ContainerConfigProperty.builder()
                        .containerArguments(List.of("containerArguments"))
                        .containerEntrypoint(List.of("containerEntrypoint"))
                        .containerEnvironmentVariables(List.of(CustomImageContainerEnvironmentVariableProperty.builder()
                                .key("key")
                                .value("value")
                                .build()))
                        .build())
                .build())
        .kernelGatewayImageConfig(KernelGatewayImageConfigProperty.builder()
                .kernelSpecs(List.of(KernelSpecProperty.builder()
                        .name("name")

                        // the properties below are optional
                        .displayName("displayName")
                        .build()))

                // the properties below are optional
                .fileSystemConfig(FileSystemConfigProperty.builder()
                        .defaultGid(123)
                        .defaultUid(123)
                        .mountPath("mountPath")
                        .build())
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var cfnAppImageConfigProps = new CfnAppImageConfigProps {
    AppImageConfigName = "appImageConfigName",

    // the properties below are optional
    CodeEditorAppImageConfig = new CodeEditorAppImageConfigProperty {
        ContainerConfig = new ContainerConfigProperty {
            ContainerArguments = new [] { "containerArguments" },
            ContainerEntrypoint = new [] { "containerEntrypoint" },
            ContainerEnvironmentVariables = new [] { new CustomImageContainerEnvironmentVariableProperty {
                Key = "key",
                Value = "value"
            } }
        }
    },
    JupyterLabAppImageConfig = new JupyterLabAppImageConfigProperty {
        ContainerConfig = new ContainerConfigProperty {
            ContainerArguments = new [] { "containerArguments" },
            ContainerEntrypoint = new [] { "containerEntrypoint" },
            ContainerEnvironmentVariables = new [] { new CustomImageContainerEnvironmentVariableProperty {
                Key = "key",
                Value = "value"
            } }
        }
    },
    KernelGatewayImageConfig = new KernelGatewayImageConfigProperty {
        KernelSpecs = new [] { new KernelSpecProperty {
            Name = "name",

            // the properties below are optional
            DisplayName = "displayName"
        } },

        // the properties below are optional
        FileSystemConfig = new FileSystemConfigProperty {
            DefaultGid = 123,
            DefaultUid = 123,
            MountPath = "mountPath"
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAppImageConfigProps := &CfnAppImageConfigProps{
	AppImageConfigName: jsii.String("appImageConfigName"),

	// the properties below are optional
	CodeEditorAppImageConfig: &CodeEditorAppImageConfigProperty{
		ContainerConfig: &ContainerConfigProperty{
			ContainerArguments: []*string{
				jsii.String("containerArguments"),
			},
			ContainerEntrypoint: []*string{
				jsii.String("containerEntrypoint"),
			},
			ContainerEnvironmentVariables: []interface{}{
				&CustomImageContainerEnvironmentVariableProperty{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
		},
	},
	JupyterLabAppImageConfig: &JupyterLabAppImageConfigProperty{
		ContainerConfig: &ContainerConfigProperty{
			ContainerArguments: []*string{
				jsii.String("containerArguments"),
			},
			ContainerEntrypoint: []*string{
				jsii.String("containerEntrypoint"),
			},
			ContainerEnvironmentVariables: []interface{}{
				&CustomImageContainerEnvironmentVariableProperty{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
		},
	},
	KernelGatewayImageConfig: &KernelGatewayImageConfigProperty{
		KernelSpecs: []interface{}{
			&KernelSpecProperty{
				Name: jsii.String("name"),

				// the properties below are optional
				DisplayName: jsii.String("displayName"),
			},
		},

		// the properties below are optional
		FileSystemConfig: &FileSystemConfigProperty{
			DefaultGid: jsii.Number(123),
			DefaultUid: jsii.Number(123),
			MountPath: jsii.String("mountPath"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

appImageConfigNamestringapp_image_config_namestrappImageConfigNameStringAppImageConfigNamestringAppImageConfigName*stringrequired#
The name of the AppImageConfig.

Must be unique to your account.

codeEditorAppImageConfigoptionalIResolvable | CfnAppImageConfig.CodeEditorAppImageConfigPropertycode_editor_app_image_configoptionaltyping.Union[IResolvable, CodeEditorAppImageConfigProperty]codeEditorAppImageConfigoptionalIResolvableCodeEditorAppImageConfigoptionalIResolvableCodeEditorAppImageConfigoptionalinterface{}#
The configuration for the file system and the runtime, such as the environment variables and entry point.
jupyterLabAppImageConfigoptionalIResolvable | CfnAppImageConfig.JupyterLabAppImageConfigPropertyjupyter_lab_app_image_configoptionaltyping.Union[IResolvable, JupyterLabAppImageConfigProperty]jupyterLabAppImageConfigoptionalIResolvableJupyterLabAppImageConfigoptionalIResolvableJupyterLabAppImageConfigoptionalinterface{}#
The configuration for the file system and the runtime, such as the environment variables and entry point.
kernelGatewayImageConfigoptionalIResolvable | CfnAppImageConfig.KernelGatewayImageConfigPropertykernel_gateway_image_configoptionaltyping.Union[IResolvable, KernelGatewayImageConfigProperty]kernelGatewayImageConfigoptionalIResolvableKernelGatewayImageConfigoptionalIResolvableKernelGatewayImageConfigoptionalinterface{}#
The configuration for the file system and kernels in the SageMaker AI image.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .