Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.ModelPackageContainerDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackage.ModelPackageContainerDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

@Stability(Stable)
public static interface CfnModelPackage.ModelPackageContainerDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Describes the Docker container for the model package.

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.*;
 Object modelInput;
 ModelPackageContainerDefinitionProperty modelPackageContainerDefinitionProperty = ModelPackageContainerDefinitionProperty.builder()
         .image("image")
         // the properties below are optional
         .containerHostname("containerHostname")
         .environment(Map.of(
                 "environmentKey", "environment"))
         .framework("framework")
         .frameworkVersion("frameworkVersion")
         .imageDigest("imageDigest")
         .modelDataSource(ModelDataSourceProperty.builder()
                 .s3DataSource(S3ModelDataSourceProperty.builder()
                         .compressionType("compressionType")
                         .s3DataType("s3DataType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .modelAccessConfig(ModelAccessConfigProperty.builder()
                                 .acceptEula(false)
                                 .build())
                         .build())
                 .build())
         .modelDataUrl("modelDataUrl")
         .modelInput(modelInput)
         .nearestModelName("nearestModelName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelPackage.ModelPackageContainerDefinitionProperty.Builder	A builder for CfnModelPackage.ModelPackageContainerDefinitionProperty
static final class	CfnModelPackage.ModelPackageContainerDefinitionProperty.Jsii$Proxy	An implementation for CfnModelPackage.ModelPackageContainerDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnModelPackage.ModelPackageContainerDefinitionProperty.Builder	builder()
default String	getContainerHostname()	The DNS host name for the Docker container.
default Object	getEnvironment()	The environment variables to set in the Docker container.
default String	getFramework()	The machine learning framework of the model package container image.
default String	getFrameworkVersion()	The framework version of the Model Package Container Image.
String	getImage()	The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
default String	getImageDigest()	An MD5 hash of the training algorithm that identifies the Docker image used for training.
default Object	getModelDataSource()	Specifies the location of ML model data to deploy during endpoint creation.
default String	getModelDataUrl()	The Amazon S3 path where the model artifacts, which result from model training, are stored.
default Object	getModelInput()	A structure with Model Input details.
default String	getNearestModelName()	The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Stable)
@NotNull
String getImage()

The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-image

getContainerHostname

@Stability(Stable)
@Nullable
default String getContainerHostname()

The DNS host name for the Docker container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-containerhostname

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

The environment variables to set in the Docker container.

Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-environment

getFramework

@Stability(Stable)
@Nullable
default String getFramework()

The machine learning framework of the model package container image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-framework

getFrameworkVersion

@Stability(Stable)
@Nullable
default String getFrameworkVersion()

The framework version of the Model Package Container Image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-frameworkversion

getImageDigest

@Stability(Stable)
@Nullable
default String getImageDigest()

An MD5 hash of the training algorithm that identifies the Docker image used for training.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-imagedigest

getModelDataSource

@Stability(Stable)
@Nullable
default Object getModelDataSource()

Specifies the location of ML model data to deploy during endpoint creation.

Returns union: either IResolvable or CfnModelPackage.ModelDataSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modeldatasource

getModelDataUrl

@Stability(Stable)
@Nullable
default String getModelDataUrl()

The Amazon S3 path where the model artifacts, which result from model training, are stored.

This path must point to a single gzip compressed tar archive ( .tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modeldataurl

getModelInput

@Stability(Stable)
@Nullable
default Object getModelInput()

A structure with Model Input details.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-modelinput

getNearestModelName

@Stability(Stable)
@Nullable
default String getNearestModelName()

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

You can find a list of benchmarked models by calling ListModelMetadata .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html#cfn-sagemaker-modelpackage-modelpackagecontainerdefinition-nearestmodelname

builder

@Stability(Stable)
static CfnModelPackage.ModelPackageContainerDefinitionProperty.Builder builder()

Returns:

a CfnModelPackage.ModelPackageContainerDefinitionProperty.Builder of CfnModelPackage.ModelPackageContainerDefinitionProperty