Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnAppImageConfigPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnAppImageConfigPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.854Z")
@Stability(Stable)
public class CfnAppImageConfigPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a configuration for running a SageMaker AI image as a KernelGateway app.

The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAppImageConfigPropsMixin cfnAppImageConfigPropsMixin = CfnAppImageConfigPropsMixin.Builder.create(CfnAppImageConfigMixinProps.builder()
         .appImageConfigName("appImageConfigName")
         .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()
                 .fileSystemConfig(FileSystemConfigProperty.builder()
                         .defaultGid(123)
                         .defaultUid(123)
                         .mountPath("mountPath")
                         .build())
                 .kernelSpecs(List.of(KernelSpecProperty.builder()
                         .displayName("displayName")
                         .name("name")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAppImageConfigPropsMixin.Builder	A fluent builder for CfnAppImageConfigPropsMixin.
static interface	CfnAppImageConfigPropsMixin.CodeEditorAppImageConfigProperty	The configuration for the file system and kernels in a SageMaker image running as a Code Editor app.
static interface	CfnAppImageConfigPropsMixin.ContainerConfigProperty	The configuration used to run the application image container.
static interface	CfnAppImageConfigPropsMixin.CustomImageContainerEnvironmentVariableProperty	The environment variables to set in the container.
static interface	CfnAppImageConfigPropsMixin.FileSystemConfigProperty	The Amazon Elastic File System storage configuration for a SageMaker AI image.
static interface	CfnAppImageConfigPropsMixin.JupyterLabAppImageConfigProperty	The configuration for the file system and kernels in a SageMaker AI image running as a JupyterLab app.
static interface	CfnAppImageConfigPropsMixin.KernelGatewayImageConfigProperty	The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app.
static interface	CfnAppImageConfigPropsMixin.KernelSpecProperty	The specification of a Jupyter kernel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAppImageConfigPropsMixin(CfnAppImageConfigMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::AppImageConfig.
	CfnAppImageConfigPropsMixin(CfnAppImageConfigMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::AppImageConfig.
protected	CfnAppImageConfigPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAppImageConfigPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAppImageConfigMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAppImageConfigPropsMixin

protected CfnAppImageConfigPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnAppImageConfigPropsMixin

protected CfnAppImageConfigPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAppImageConfigPropsMixin

@Stability(Stable)
public CfnAppImageConfigPropsMixin(@NotNull
 CfnAppImageConfigMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::AppImageConfig.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAppImageConfigPropsMixin

@Stability(Stable)
public CfnAppImageConfigPropsMixin(@NotNull
 CfnAppImageConfigMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::AppImageConfig.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAppImageConfigMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()