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

Interface ContainerDefinitionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerDefinitionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:31.162Z")
@Stability(Stable)
public interface ContainerDefinitionOptions
extends software.amazon.jsii.JsiiSerializable

Properties to define a ContainerDefinition.

Example:

 SageMakerCreateModel.Builder.create(this, "Sagemaker")
         .modelName("MyModel")
         .primaryContainer(ContainerDefinition.Builder.create()
                 .image(DockerImage.fromJsonExpression(JsonPath.stringAt("$.Model.imageName")))
                 .mode(Mode.SINGLE_MODEL)
                 .modelS3Location(S3Location.fromJsonExpression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts"))
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContainerDefinitionOptions.Builder	builder()
default String	getContainerHostName()	This parameter is ignored for models that contain only a PrimaryContainer.
default TaskInput	getEnvironmentVariables()	The environment variables to set in the Docker container.
default DockerImage	getImage()	The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
default Mode	getMode()	Defines how many models the container hosts.
default String	getModelPackageName()	The name or Amazon Resource Name (ARN) of the model package to use to create the model.
default S3Location	getModelS3Location()	The S3 path where the model artifacts, which result from model training, are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerHostName

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

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

getEnvironmentVariables

@Stability(Stable)
@Nullable
default TaskInput getEnvironmentVariables()

The environment variables to set in the Docker container.

Default: - No variables

getImage

@Stability(Stable)
@Nullable
default DockerImage getImage()

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

Default: - None

getMode

@Stability(Stable)
@Nullable
default Mode getMode()

Defines how many models the container hosts.

Default: - Mode.SINGLE_MODEL

getModelPackageName

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

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

Default: - None

getModelS3Location

@Stability(Stable)
@Nullable
default S3Location getModelS3Location()

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

builder

@Stability(Stable)
static ContainerDefinitionOptions.Builder builder()

Returns:

a ContainerDefinitionOptions.Builder of ContainerDefinitionOptions