Package software.amazon.awscdk.services.sagemaker

Class CfnAppImageConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnAppImageConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.078Z") @Stability(Stable) public class CfnAppImageConfig extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::AppImageConfig.

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) 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
         .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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • 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()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getAppImageConfigName

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

      Must be unique to your account.

    • setAppImageConfigName

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

      Must be unique to your account.

    • getKernelGatewayImageConfig

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

    • setKernelGatewayImageConfig

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

    • setKernelGatewayImageConfig

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