software.amazon.awscdk.services.stepfunctions.tasks

Class ContainerDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.ContainerDefinition.Builder

Enclosing class:

ContainerDefinition

public static final class ContainerDefinition.Builder
extends java.lang.Object

A fluent builder for ContainerDefinition.

Method Summary

Modifier and Type	Method and Description
ContainerDefinition	build()
ContainerDefinition.Builder	containerHostName(java.lang.String containerHostName) This parameter is ignored for models that contain only a PrimaryContainer.
static ContainerDefinition.Builder	create()
ContainerDefinition.Builder	environmentVariables(TaskInput environmentVariables) The environment variables to set in the Docker container.
ContainerDefinition.Builder	image(DockerImage image) The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
ContainerDefinition.Builder	mode(Mode mode) Defines how many models the container hosts.
ContainerDefinition.Builder	modelPackageName(java.lang.String modelPackageName) The name or Amazon Resource Name (ARN) of the model package to use to create the model.
ContainerDefinition.Builder	modelS3Location(S3Location modelS3Location) The S3 path where the model artifacts, which result from model training, are stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ContainerDefinition.Builder create()

Returns:

a new instance of ContainerDefinition.Builder.

containerHostName

public ContainerDefinition.Builder containerHostName(java.lang.String containerHostName)

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics.

Default: - None

Parameters:

containerHostName - This parameter is ignored for models that contain only a PrimaryContainer. This parameter is required.

Returns:

this

environmentVariables

public ContainerDefinition.Builder environmentVariables(TaskInput environmentVariables)

The environment variables to set in the Docker container.

Default: - No variables

Parameters:

environmentVariables - The environment variables to set in the Docker container. This parameter is required.

Returns:

this

image

public ContainerDefinition.Builder image(DockerImage image)

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

Default: - None

Parameters:

image - The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. This parameter is required.

Returns:

this

mode

public ContainerDefinition.Builder mode(Mode mode)

Defines how many models the container hosts.

Default: - Mode.SINGLE_MODEL

Parameters:

mode - Defines how many models the container hosts. This parameter is required.

Returns:

this

modelPackageName

public ContainerDefinition.Builder modelPackageName(java.lang.String modelPackageName)

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

Default: - None

Parameters:

modelPackageName - The name or Amazon Resource Name (ARN) of the model package to use to create the model. This parameter is required.

Returns:

this

modelS3Location

public ContainerDefinition.Builder modelS3Location(S3Location modelS3Location)

The 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 S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.

Default: - None

Parameters:

modelS3Location - The S3 path where the model artifacts, which result from model training, are stored. This parameter is required.

Returns:

this

build

public ContainerDefinition build()