Package software.amazon.awscdk.services.sagemaker.alpha

Interface ContainerDefinition

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerDefinition.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:26.114Z")
@Stability(Experimental)
public interface ContainerDefinition
extends software.amazon.jsii.JsiiSerializable

(experimental) Describes the container, as part of model definition.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.alpha.*;
 ContainerImage containerImage;
 ModelData modelData;
 ContainerDefinition containerDefinition = ContainerDefinition.builder()
         .image(containerImage)
         // the properties below are optional
         .containerHostname("containerHostname")
         .environment(Map.of(
                 "environmentKey", "environment"))
         .modelData(modelData)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContainerDefinition.Builder	builder()
default String	getContainerHostname()	(experimental) Hostname of the container within an inference pipeline.
default Map<String,String>	getEnvironment()	(experimental) A map of environment variables to pass into the container.
ContainerImage	getImage()	(experimental) The image used to start a container.
default ModelData	getModelData()	(experimental) S3 path to the model artifacts.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Experimental)
@NotNull
ContainerImage getImage()

(experimental) The image used to start a container.

getContainerHostname

@Stability(Experimental)
@Nullable
default String getContainerHostname()

(experimental) Hostname of the container within an inference pipeline.

For single container models, this field is ignored. When specifying a hostname for one ContainerDefinition in a pipeline, hostnames must be specified for all other ContainerDefinitions in that pipeline.

Default: - Amazon SageMaker will automatically assign a unique name based on the position of this ContainerDefinition in an inference pipeline.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname

getEnvironment

@Stability(Experimental)
@Nullable
default Map<String,String> getEnvironment()

(experimental) A map of environment variables to pass into the container.

Default: - none

getModelData

@Stability(Experimental)
@Nullable
default ModelData getModelData()

(experimental) S3 path to the model artifacts.

Default: - none

builder

@Stability(Experimental)
static ContainerDefinition.Builder builder()

Returns:

a ContainerDefinition.Builder of ContainerDefinition