software.amazon.awssdk.services.sagemaker.model

Class ContainerDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ContainerDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerDefinition.Builder,ContainerDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public final class ContainerDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerDefinition.Builder,ContainerDefinition>

Describes the container, as part of model definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContainerDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static ContainerDefinition.Builder	builder()
String	containerHostname() This parameter is ignored for models that contain only a PrimaryContainer.
Map<String,String>	environment() The environment variables to set in the Docker container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironment() Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	image() The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
ContainerMode	mode() Whether the container hosts a single model or multiple models.
String	modeAsString() Whether the container hosts a single model or multiple models.
String	modelDataUrl() The S3 path where the model artifacts, which result from model training, are stored.
String	modelPackageName() The name or Amazon Resource Name (ARN) of the model package to use to create the model.
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerDefinition.Builder>	serializableBuilderClass()
ContainerDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

containerHostname

public 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. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

Returns:

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. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

image

public String image()

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

Returns:

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

mode

public ContainerMode mode()

Whether the container hosts a single model or multiple models.

If the service returns an enum value that is not available in the current SDK version, mode will return ContainerMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Whether the container hosts a single model or multiple models.

See Also:

ContainerMode

modeAsString

public String modeAsString()

Whether the container hosts a single model or multiple models.

If the service returns an enum value that is not available in the current SDK version, mode will return ContainerMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Whether the container hosts a single model or multiple models.

See Also:

ContainerMode

modelDataUrl

public String modelDataUrl()

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. For more information on built-in algorithms, see Common Parameters.

If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

Returns:

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. For more information on built-in algorithms, see Common Parameters.

If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

hasEnvironment

public boolean hasEnvironment()

Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

environment

public Map<String,String> environment()

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEnvironment() to see if a value was sent in this field.

Returns:

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

modelPackageName

public String modelPackageName()

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

Returns:

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

toBuilder

public ContainerDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerDefinition.Builder,ContainerDefinition>

builder

public static ContainerDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends ContainerDefinition.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo