Package software.amazon.awscdk.services.sagemaker

Class CfnAppImageConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnAppImageConfig
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAppImageConfigRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:13.508Z") @Stability(Stable) public class CfnAppImageConfig extends CfnResource implements IInspectable, IAppImageConfigRef, ITaggable
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.services.sagemaker.*;
 CfnAppImageConfig cfnAppImageConfig = CfnAppImageConfig.Builder.create(this, "MyCfnAppImageConfig")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAppImageConfig

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

    • CfnAppImageConfig

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

    • CfnAppImageConfig

      @Stability(Stable) public CfnAppImageConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppImageConfigProps props)
      Create a new AWS::SageMaker::AppImageConfig.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromAppImageConfigArn

      @Stability(Stable) @NotNull public static IAppImageConfigRef fromAppImageConfigArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IAppImageConfigRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromAppImageConfigName

      @Stability(Stable) @NotNull public static IAppImageConfigRef fromAppImageConfigName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String appImageConfigName)
      Creates a new IAppImageConfigRef from a appImageConfigName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      appImageConfigName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAppImageConfigRef

      @Stability(Stable) @NotNull public AppImageConfigReference getAppImageConfigRef()
      A reference to a AppImageConfig resource.
      Specified by:
      getAppImageConfigRef in interface IAppImageConfigRef

    • getAttrAppImageConfigArn

      @Stability(Stable) @NotNull public String getAttrAppImageConfigArn()
      The Amazon Resource Name (ARN) of the AppImageConfig, such as arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAppImageConfigName

      @Stability(Stable) @NotNull public String getAppImageConfigName()
      The name of the AppImageConfig.

    • setAppImageConfigName

      @Stability(Stable) public void setAppImageConfigName(@NotNull String value)
      The name of the AppImageConfig.

    • getCodeEditorAppImageConfig

      @Stability(Stable) @Nullable public Object getCodeEditorAppImageConfig()
      The configuration for the file system and the runtime, such as the environment variables and entry point.

      Returns union: either IResolvable or CfnAppImageConfig.CodeEditorAppImageConfigProperty

    • setCodeEditorAppImageConfig

      @Stability(Stable) public void setCodeEditorAppImageConfig(@Nullable IResolvable value)
      The configuration for the file system and the runtime, such as the environment variables and entry point.

    • setCodeEditorAppImageConfig

      @Stability(Stable) public void setCodeEditorAppImageConfig(@Nullable CfnAppImageConfig.CodeEditorAppImageConfigProperty value)
      The configuration for the file system and the runtime, such as the environment variables and entry point.

    • getJupyterLabAppImageConfig

      @Stability(Stable) @Nullable public Object getJupyterLabAppImageConfig()
      The configuration for the file system and the runtime, such as the environment variables and entry point.

      Returns union: either IResolvable or CfnAppImageConfig.JupyterLabAppImageConfigProperty

    • setJupyterLabAppImageConfig

      @Stability(Stable) public void setJupyterLabAppImageConfig(@Nullable IResolvable value)
      The configuration for the file system and the runtime, such as the environment variables and entry point.

    • setJupyterLabAppImageConfig

      @Stability(Stable) public void setJupyterLabAppImageConfig(@Nullable CfnAppImageConfig.JupyterLabAppImageConfigProperty value)
      The configuration for the file system and the runtime, such as the environment variables and entry point.

    • getKernelGatewayImageConfig

      @Stability(Stable) @Nullable public Object getKernelGatewayImageConfig()
      The configuration for the file system and kernels in the SageMaker AI image.

      Returns union: either IResolvable or CfnAppImageConfig.KernelGatewayImageConfigProperty

    • setKernelGatewayImageConfig

      @Stability(Stable) public void setKernelGatewayImageConfig(@Nullable IResolvable value)
      The configuration for the file system and kernels in the SageMaker AI image.

    • setKernelGatewayImageConfig

      @Stability(Stable) public void setKernelGatewayImageConfig(@Nullable CfnAppImageConfig.KernelGatewayImageConfigProperty value)
      The configuration for the file system and kernels in the SageMaker AI image.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.