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

Class ContainerDefinition.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.ContainerDefinition.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ContainerDefinition>
Enclosing class:
ContainerDefinition
@Stability(Stable) public static final class ContainerDefinition.Builder extends Object implements software.amazon.jsii.Builder<ContainerDefinition>
A fluent builder for ContainerDefinition.

  • Method Details

    • create

      @Stability(Stable) public static ContainerDefinition.Builder create()
      Returns:
      a new instance of ContainerDefinition.Builder.

    • containerHostName

      @Stability(Stable) public ContainerDefinition.Builder containerHostName(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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public ContainerDefinition.Builder modelPackageName(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

      @Stability(Stable) 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

      @Stability(Stable) public ContainerDefinition build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ContainerDefinition>
      Returns:
      a newly built instance of ContainerDefinition.