ContainerDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.ContainerDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContainerDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the container, as part of model definition.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerDefinition()

Constructors
Constructor and Description
`ContainerDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerDefinition`	`addEnvironmentEntry(String key, String value)`
`ContainerDefinition`	`clearEnvironmentEntries()` Removes all the entries added into Environment.
`ContainerDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContainerHostname()` This parameter is ignored.
`Map<String,String>`	`getEnvironment()` The environment variables to set in the Docker container.
`String`	`getImage()` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`String`	`getModelDataUrl()` The S3 path where the model artifacts, which result from model training, are stored.
`String`	`getModelPackageName()` The name of the model package to use to create the model.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerHostname(String containerHostname)` This parameter is ignored.
`void`	`setEnvironment(Map<String,String> environment)` The environment variables to set in the Docker container.
`void`	`setImage(String image)` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`void`	`setModelDataUrl(String modelDataUrl)` The S3 path where the model artifacts, which result from model training, are stored.
`void`	`setModelPackageName(String modelPackageName)` The name of the model package to use to create the model.
`String`	`toString()` Returns a string representation of this object.
`ContainerDefinition`	`withContainerHostname(String containerHostname)` This parameter is ignored.
`ContainerDefinition`	`withEnvironment(Map<String,String> environment)` The environment variables to set in the Docker container.
`ContainerDefinition`	`withImage(String image)` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`ContainerDefinition`	`withModelDataUrl(String modelDataUrl)` The S3 path where the model artifacts, which result from model training, are stored.
`ContainerDefinition`	`withModelPackageName(String modelPackageName)` The name of the model package to use to create the model.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ContainerDefinition
```
public ContainerDefinition()
```
- Method Detail
  - setContainerHostname
```
public void setContainerHostname(String containerHostname)
```
    This parameter is ignored.
    
    Parameters:
    
    containerHostname - This parameter is ignored.
  - getContainerHostname
```
public String getContainerHostname()
```
    This parameter is ignored.
    
    Returns:
    
    This parameter is ignored.
  - withContainerHostname
```
public ContainerDefinition withContainerHostname(String containerHostname)
```
    This parameter is ignored.
    
    Parameters:
    
    containerHostname - This parameter is ignored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImage
```
public void setImage(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
    
    Parameters:
    
    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
  - getImage
```
public String getImage()
```
    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
  - withImage
```
public ContainerDefinition withImage(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelDataUrl
```
public void setModelDataUrl(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).
    
    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.
    
    Parameters:
    
    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).
    
    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.
  - getModelDataUrl
```
public String getModelDataUrl()
```
    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).
    
    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.
    
    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).
    
    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.
  - withModelDataUrl
```
public ContainerDefinition withModelDataUrl(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).
    
    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.
    
    Parameters:
    
    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).
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public Map<String,String> getEnvironment()
```
    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.
    
    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.
  - setEnvironment
```
public void setEnvironment(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.
    
    Parameters:
    
    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.
  - withEnvironment
```
public ContainerDefinition withEnvironment(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentEntry
```
public ContainerDefinition addEnvironmentEntry(String key,
                                               String value)
```
  - clearEnvironmentEntries
```
public ContainerDefinition clearEnvironmentEntries()
```
    Removes all the entries added into Environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageName
```
public void setModelPackageName(String modelPackageName)
```
    The name of the model package to use to create the model.
    
    Parameters:
    
    modelPackageName - The name of the model package to use to create the model.
  - getModelPackageName
```
public String getModelPackageName()
```
    The name of the model package to use to create the model.
    
    Returns:
    
    The name of the model package to use to create the model.
  - withModelPackageName
```
public ContainerDefinition withModelPackageName(String modelPackageName)
```
    The name of the model package to use to create the model.
    
    Parameters:
    
    modelPackageName - The name of the model package to use to create the model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ContainerDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ContainerDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerDefinition

Method Detail

setContainerHostname

getContainerHostname

withContainerHostname

setImage

getImage

withImage

setModelDataUrl

getModelDataUrl

withModelDataUrl

getEnvironment

setEnvironment

withEnvironment

addEnvironmentEntry

clearEnvironmentEntries

setModelPackageName

getModelPackageName

withModelPackageName

toString

equals

hashCode

clone

marshall