CfnAppImageConfigProps

class aws_cdk.aws_sagemaker.CfnAppImageConfigProps(*, app_image_config_name, code_editor_app_image_config=None, jupyter_lab_app_image_config=None, kernel_gateway_image_config=None, tags=None)

Bases: object

Properties for defining a CfnAppImageConfig.

Parameters:
  • app_image_config_name (str) – The name of the AppImageConfig. Must be unique to your account.

  • code_editor_app_image_config (Union[IResolvable, CodeEditorAppImageConfigProperty, Dict[str, Any], None]) – The configuration for the file system and the runtime, such as the environment variables and entry point.

  • jupyter_lab_app_image_config (Union[IResolvable, JupyterLabAppImageConfigProperty, Dict[str, Any], None]) – The configuration for the file system and the runtime, such as the environment variables and entry point.

  • kernel_gateway_image_config (Union[IResolvable, KernelGatewayImageConfigProperty, Dict[str, Any], None]) – The configuration for the file system and kernels in the SageMaker image.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html

ExampleMetadata:

fixture=_generated

Example:

# 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"
    )]
)

Attributes

app_image_config_name

The name of the AppImageConfig.

Must be unique to your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-appimageconfigname

code_editor_app_image_config

The configuration for the file system and the runtime, such as the environment variables and entry point.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-codeeditorappimageconfig

jupyter_lab_app_image_config

The configuration for the file system and the runtime, such as the environment variables and entry point.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig

kernel_gateway_image_config

The configuration for the file system and kernels in the SageMaker image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html#cfn-sagemaker-appimageconfig-tags