Package software.amazon.awscdk.services.stepfunctions.tasks

Class ContainerDefinitionOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerDefinitionOptions>

Enclosing interface:

ContainerDefinitionOptions

@Stability(Stable)
public static final class ContainerDefinitionOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ContainerDefinitionOptions>

A builder for ContainerDefinitionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerDefinitionOptions	build()	Builds the configured instance.
ContainerDefinitionOptions.Builder	containerHostName(String containerHostName)	Sets the value of ContainerDefinitionOptions.getContainerHostName()
ContainerDefinitionOptions.Builder	environmentVariables(TaskInput environmentVariables)	Sets the value of ContainerDefinitionOptions.getEnvironmentVariables()
ContainerDefinitionOptions.Builder	image(DockerImage image)	Sets the value of ContainerDefinitionOptions.getImage()
ContainerDefinitionOptions.Builder	mode(Mode mode)	Sets the value of ContainerDefinitionOptions.getMode()
ContainerDefinitionOptions.Builder	modelPackageName(String modelPackageName)	Sets the value of ContainerDefinitionOptions.getModelPackageName()
ContainerDefinitionOptions.Builder	modelS3Location(S3Location modelS3Location)	Sets the value of ContainerDefinitionOptions.getModelS3Location()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

containerHostName

@Stability(Stable)
public ContainerDefinitionOptions.Builder containerHostName(String containerHostName)

Sets the value of ContainerDefinitionOptions.getContainerHostName()

Parameters:

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.

Returns:

this

environmentVariables

@Stability(Stable)
public ContainerDefinitionOptions.Builder environmentVariables(TaskInput environmentVariables)

Sets the value of ContainerDefinitionOptions.getEnvironmentVariables()

Parameters:

environmentVariables - The environment variables to set in the Docker container.

Returns:

this

image

@Stability(Stable)
public ContainerDefinitionOptions.Builder image(DockerImage image)

Sets the value of ContainerDefinitionOptions.getImage()

Parameters:

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

Returns:

this

mode

@Stability(Stable)
public ContainerDefinitionOptions.Builder mode(Mode mode)

Sets the value of ContainerDefinitionOptions.getMode()

Parameters:

mode - Defines how many models the container hosts.

Returns:

this

modelPackageName

@Stability(Stable)
public ContainerDefinitionOptions.Builder modelPackageName(String modelPackageName)

Sets the value of ContainerDefinitionOptions.getModelPackageName()

Parameters:

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

Returns:

this

modelS3Location

@Stability(Stable)
public ContainerDefinitionOptions.Builder modelS3Location(S3Location modelS3Location)

Sets the value of ContainerDefinitionOptions.getModelS3Location()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public ContainerDefinitionOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ContainerDefinitionOptions>

Returns:

a new instance of ContainerDefinitionOptions

Throws:

NullPointerException - if any required attribute was not provided