software.amazon.awssdk.services.sagemaker.model

Interface ModelPackageContainerDefinition.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>, SdkBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>, SdkPojo

Enclosing class:

ModelPackageContainerDefinition

public static interface ModelPackageContainerDefinition.Builder
extends SdkPojo, CopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>

Method Summary

Modifier and Type	Method and Description
ModelPackageContainerDefinition.Builder	containerHostname(String containerHostname) The DNS host name for the Docker container.
ModelPackageContainerDefinition.Builder	environment(Map<String,String> environment) The environment variables to set in the Docker container.
ModelPackageContainerDefinition.Builder	framework(String framework) The machine learning framework of the model package container image.
ModelPackageContainerDefinition.Builder	frameworkVersion(String frameworkVersion) The framework version of the Model Package Container Image.
ModelPackageContainerDefinition.Builder	image(String image) The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
ModelPackageContainerDefinition.Builder	imageDigest(String imageDigest) An MD5 hash of the training algorithm that identifies the Docker image used for training.
ModelPackageContainerDefinition.Builder	modelDataUrl(String modelDataUrl) The Amazon S3 path where the model artifacts, which result from model training, are stored.
default ModelPackageContainerDefinition.Builder	modelInput(Consumer<ModelInput.Builder> modelInput) A structure with Model Input details.
ModelPackageContainerDefinition.Builder	modelInput(ModelInput modelInput) A structure with Model Input details.
ModelPackageContainerDefinition.Builder	nearestModelName(String nearestModelName) The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
ModelPackageContainerDefinition.Builder	productId(String productId) The Amazon Web Services Marketplace product ID of the model package.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

containerHostname

ModelPackageContainerDefinition.Builder containerHostname(String containerHostname)

The DNS host name for the Docker container.

Parameters:

containerHostname - The DNS host name for the Docker container.

Returns:

Returns a reference to this object so that method calls can be chained together.

image

ModelPackageContainerDefinition.Builder image(String image)

The Amazon EC2 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.

Parameters:

image - The Amazon EC2 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageDigest

ModelPackageContainerDefinition.Builder imageDigest(String imageDigest)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

modelDataUrl

ModelPackageContainerDefinition.Builder modelDataUrl(String modelDataUrl)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

productId

ModelPackageContainerDefinition.Builder productId(String productId)

The Amazon Web Services Marketplace product ID of the model package.

Parameters:

productId - The Amazon Web Services Marketplace product ID of the model package.

Returns:

Returns a reference to this object so that method calls can be chained together.

environment

ModelPackageContainerDefinition.Builder environment(Map<String,String> environment)

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.

Parameters:

environment - 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:

Returns a reference to this object so that method calls can be chained together.

modelInput

ModelPackageContainerDefinition.Builder modelInput(ModelInput modelInput)

A structure with Model Input details.

Parameters:

modelInput - A structure with Model Input details.

Returns:

Returns a reference to this object so that method calls can be chained together.

modelInput

default ModelPackageContainerDefinition.Builder modelInput(Consumer<ModelInput.Builder> modelInput)

A structure with Model Input details.

This is a convenience method that creates an instance of the ModelInput.Builder avoiding the need to create one manually via ModelInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelInput(ModelInput).

Parameters:

modelInput - a consumer that will call methods on ModelInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

modelInput(ModelInput)

framework

ModelPackageContainerDefinition.Builder framework(String framework)

The machine learning framework of the model package container image.

Parameters:

framework - The machine learning framework of the model package container image.

Returns:

Returns a reference to this object so that method calls can be chained together.

frameworkVersion

ModelPackageContainerDefinition.Builder frameworkVersion(String frameworkVersion)

The framework version of the Model Package Container Image.

Parameters:

frameworkVersion - The framework version of the Model Package Container Image.

Returns:

Returns a reference to this object so that method calls can be chained together.

nearestModelName

ModelPackageContainerDefinition.Builder nearestModelName(String nearestModelName)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.