java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.sagemaker.alpha.ModelData
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:43:00.383Z") @Stability(Experimental) public abstract class ModelData extends software.amazon.jsii.JsiiObject
(experimental) Model data represents the source of model artifacts, which will ultimately be loaded from an S3 location.

Example:

 import software.amazon.awscdk.services.sagemaker.alpha.*;
 import path.*;
 ContainerImage image = ContainerImage.fromAsset(join("path", "to", "Dockerfile", "directory"));
 ModelData modelData = ModelData.fromAsset(join("path", "to", "artifact", "file.tar.gz"));
 Model model = Model.Builder.create(this, "PrimaryContainerModel")
         .containers(List.of(ContainerDefinition.builder()
                 .image(image)
                 .modelData(modelData)
                 .build()))
         .build();
 
  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
     
    protected
    ModelData(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ModelData(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    bind(software.constructs.Construct scope, IModel model)
    (experimental) This method is invoked by the SageMaker Model construct when it needs to resolve the model data to a URI.
    static ModelData
    (experimental) Constructs model data that will be uploaded to S3 as part of the CDK app deployment.
    static ModelData
    fromAsset(String path, AssetOptions options)
    (experimental) Constructs model data that will be uploaded to S3 as part of the CDK app deployment.
    static ModelData
    fromBucket(IBucket bucket, String objectKey)
    (experimental) Constructs model data which is already available within S3.

    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
  • Constructor Details

    • ModelData

      protected ModelData(software.amazon.jsii.JsiiObjectRef objRef)
    • ModelData

      protected ModelData(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • ModelData

      @Stability(Experimental) protected ModelData()
  • Method Details

    • fromAsset

      @Stability(Experimental) @NotNull public static ModelData fromAsset(@NotNull String path, @Nullable AssetOptions options)
      (experimental) Constructs model data that will be uploaded to S3 as part of the CDK app deployment.

      Parameters:
      path - The local path to a model artifact file as a gzipped tar file. This parameter is required.
      options - The options to further configure the selected asset.
    • fromAsset

      @Stability(Experimental) @NotNull public static ModelData fromAsset(@NotNull String path)
      (experimental) Constructs model data that will be uploaded to S3 as part of the CDK app deployment.

      Parameters:
      path - The local path to a model artifact file as a gzipped tar file. This parameter is required.
    • fromBucket

      @Stability(Experimental) @NotNull public static ModelData fromBucket(@NotNull IBucket bucket, @NotNull String objectKey)
      (experimental) Constructs model data which is already available within S3.

      Parameters:
      bucket - The S3 bucket within which the model artifacts are stored. This parameter is required.
      objectKey - The S3 object key at which the model artifacts are stored. This parameter is required.
    • bind

      @Stability(Experimental) @NotNull public abstract ModelDataConfig bind(@NotNull software.constructs.Construct scope, @NotNull IModel model)
      (experimental) This method is invoked by the SageMaker Model construct when it needs to resolve the model data to a URI.

      Parameters:
      scope - The scope within which the model data is resolved. This parameter is required.
      model - The Model construct performing the URI resolution. This parameter is required.