ContainerDefinition (AWS Java SDK for the Amazon EC2 Container Service 1.9.23 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class ContainerDefinition
extends Object
implements Serializable, Cloneable
```
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerDefinition()

Constructors
Constructor and Description
`ContainerDefinition()`

Method Summary

Methods
Modifier and Type	Method and Description
`ContainerDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCommand()` The `CMD` that is passed to the container.
`Integer`	`getCpu()` The number of `cpu` units reserved for the container.
`List<String>`	`getEntryPoint()`
`List<KeyValuePair>`	`getEnvironment()` The environment variables to pass to a container.
`Boolean`	`getEssential()` If the `essential` parameter of a container is marked as `true`, the failure of that container will stop the task.
`String`	`getImage()` The image used to start a container.
`List<String>`	`getLinks()` The `link` parameter allows containers to communicate with each other without the need for port mappings, using the `name` parameter.
`Integer`	`getMemory()` The number of MiB of memory reserved for the container.
`List<MountPoint>`	`getMountPoints()` The mount points for data volumes in your container.
`String`	`getName()` The name of a container.
`List<PortMapping>`	`getPortMappings()` The list of port mappings for the container.
`List<VolumeFrom>`	`getVolumesFrom()` Data volumes to mount from another container.
`int`	`hashCode()`
`Boolean`	`isEssential()` If the `essential` parameter of a container is marked as `true`, the failure of that container will stop the task.
`void`	`setCommand(Collection<String> command)` The `CMD` that is passed to the container.
`void`	`setCpu(Integer cpu)` The number of `cpu` units reserved for the container.
`void`	`setEntryPoint(Collection<String> entryPoint)`
`void`	`setEnvironment(Collection<KeyValuePair> environment)` The environment variables to pass to a container.
`void`	`setEssential(Boolean essential)` If the `essential` parameter of a container is marked as `true`, the failure of that container will stop the task.
`void`	`setImage(String image)` The image used to start a container.
`void`	`setLinks(Collection<String> links)` The `link` parameter allows containers to communicate with each other without the need for port mappings, using the `name` parameter.
`void`	`setMemory(Integer memory)` The number of MiB of memory reserved for the container.
`void`	`setMountPoints(Collection<MountPoint> mountPoints)` The mount points for data volumes in your container.
`void`	`setName(String name)` The name of a container.
`void`	`setPortMappings(Collection<PortMapping> portMappings)` The list of port mappings for the container.
`void`	`setVolumesFrom(Collection<VolumeFrom> volumesFrom)` Data volumes to mount from another container.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ContainerDefinition`	`withCommand(Collection<String> command)` The `CMD` that is passed to the container.
`ContainerDefinition`	`withCommand(String... command)` The `CMD` that is passed to the container.
`ContainerDefinition`	`withCpu(Integer cpu)` The number of `cpu` units reserved for the container.
`ContainerDefinition`	`withEntryPoint(Collection<String> entryPoint)`
`ContainerDefinition`	`withEntryPoint(String... entryPoint)`
`ContainerDefinition`	`withEnvironment(Collection<KeyValuePair> environment)` The environment variables to pass to a container.
`ContainerDefinition`	`withEnvironment(KeyValuePair... environment)` The environment variables to pass to a container.
`ContainerDefinition`	`withEssential(Boolean essential)` If the `essential` parameter of a container is marked as `true`, the failure of that container will stop the task.
`ContainerDefinition`	`withImage(String image)` The image used to start a container.
`ContainerDefinition`	`withLinks(Collection<String> links)` The `link` parameter allows containers to communicate with each other without the need for port mappings, using the `name` parameter.
`ContainerDefinition`	`withLinks(String... links)` The `link` parameter allows containers to communicate with each other without the need for port mappings, using the `name` parameter.
`ContainerDefinition`	`withMemory(Integer memory)` The number of MiB of memory reserved for the container.
`ContainerDefinition`	`withMountPoints(Collection<MountPoint> mountPoints)` The mount points for data volumes in your container.
`ContainerDefinition`	`withMountPoints(MountPoint... mountPoints)` The mount points for data volumes in your container.
`ContainerDefinition`	`withName(String name)` The name of a container.
`ContainerDefinition`	`withPortMappings(Collection<PortMapping> portMappings)` The list of port mappings for the container.
`ContainerDefinition`	`withPortMappings(PortMapping... portMappings)` The list of port mappings for the container.
`ContainerDefinition`	`withVolumesFrom(Collection<VolumeFrom> volumesFrom)` Data volumes to mount from another container.
`ContainerDefinition`	`withVolumesFrom(VolumeFrom... volumesFrom)` Data volumes to mount from another container.

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

- Constructor Detail
  - ContainerDefinition
```
public ContainerDefinition()
```
- Method Detail
  - getName
```
public String getName()
```
    The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
    
    Returns:
    The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
  - setName
```
public void setName(String name)
```
    The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
    
    Parameters:
    name - The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
  - withName
```
public ContainerDefinition withName(String name)
```
    The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    name - The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getImage
```
public String getImage()
```
    The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
    
    Returns:
    The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
  - setImage
```
public void setImage(String image)
```
    The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
    
    Parameters:
    image - The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
  - withImage
```
public ContainerDefinition withImage(String image)
```
    The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    image - The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCpu
```
public Integer getCpu()
```
    The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
    
    Returns:
    The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
  - setCpu
```
public void setCpu(Integer cpu)
```
    The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
    
    Parameters:
    cpu - The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
  - withCpu
```
public ContainerDefinition withCpu(Integer cpu)
```
    The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    cpu - The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMemory
```
public Integer getMemory()
```
    The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
    
    Returns:
    The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
  - setMemory
```
public void setMemory(Integer memory)
```
    The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
    
    Parameters:
    memory - The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
  - withMemory
```
public ContainerDefinition withMemory(Integer memory)
```
    The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    memory - The number of MiB of memory reserved for the container. Docker will allocate a minimum of 4 MiB of memory to a container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getLinks
```
public List<String> getLinks()
```
    The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    
    Returns:
    The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
  - setLinks
```
public void setLinks(Collection<String> links)
```
    The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    
    Parameters:
    links - The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
  - withLinks
```
public ContainerDefinition withLinks(String... links)
```
    The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    links - The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withLinks
```
public ContainerDefinition withLinks(Collection<String> links)
```
    The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    links - The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPortMappings
```
public List<PortMapping> getPortMappings()
```
    The list of port mappings for the container.
    
    Returns:
    The list of port mappings for the container.
  - setPortMappings
```
public void setPortMappings(Collection<PortMapping> portMappings)
```
    The list of port mappings for the container.
    
    Parameters:
    portMappings - The list of port mappings for the container.
  - withPortMappings
```
public ContainerDefinition withPortMappings(PortMapping... portMappings)
```
    The list of port mappings for the container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    portMappings - The list of port mappings for the container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withPortMappings
```
public ContainerDefinition withPortMappings(Collection<PortMapping> portMappings)
```
    The list of port mappings for the container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    portMappings - The list of port mappings for the container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isEssential
```
public Boolean isEssential()
```
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
    
    Returns:
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
  - setEssential
```
public void setEssential(Boolean essential)
```
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
    
    Parameters:
    essential - If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
  - withEssential
```
public ContainerDefinition withEssential(Boolean essential)
```
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    essential - If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEssential
```
public Boolean getEssential()
```
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
    
    Returns:
    If the essential parameter of a container is marked as true, the failure of that container will stop the task. If the essential parameter of a container is marked as false, then its failure will not affect the rest of the containers in a task.
  - getEntryPoint
```
public List<String> getEntryPoint()
```
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    
    Returns:
    
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
  - setEntryPoint
```
public void setEntryPoint(Collection<String> entryPoint)
```
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    
    Parameters:
    entryPoint -
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
  - withEntryPoint
```
public ContainerDefinition withEntryPoint(String... entryPoint)
```
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    entryPoint -
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withEntryPoint
```
public ContainerDefinition withEntryPoint(Collection<String> entryPoint)
```
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    entryPoint -
    Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
    The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCommand
```
public List<String> getCommand()
```
    The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    
    Returns:
    The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
  - setCommand
```
public void setCommand(Collection<String> command)
```
    The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    
    Parameters:
    command - The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
  - withCommand
```
public ContainerDefinition withCommand(String... command)
```
    The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    command - The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withCommand
```
public ContainerDefinition withCommand(Collection<String> command)
```
    The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    command - The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEnvironment
```
public List<KeyValuePair> getEnvironment()
```
    The environment variables to pass to a container.
    
    Returns:
    The environment variables to pass to a container.
  - setEnvironment
```
public void setEnvironment(Collection<KeyValuePair> environment)
```
    The environment variables to pass to a container.
    
    Parameters:
    environment - The environment variables to pass to a container.
  - withEnvironment
```
public ContainerDefinition withEnvironment(KeyValuePair... environment)
```
    The environment variables to pass to a container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    environment - The environment variables to pass to a container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withEnvironment
```
public ContainerDefinition withEnvironment(Collection<KeyValuePair> environment)
```
    The environment variables to pass to a container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    environment - The environment variables to pass to a container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMountPoints
```
public List<MountPoint> getMountPoints()
```
    The mount points for data volumes in your container.
    
    Returns:
    The mount points for data volumes in your container.
  - setMountPoints
```
public void setMountPoints(Collection<MountPoint> mountPoints)
```
    The mount points for data volumes in your container.
    
    Parameters:
    mountPoints - The mount points for data volumes in your container.
  - withMountPoints
```
public ContainerDefinition withMountPoints(MountPoint... mountPoints)
```
    The mount points for data volumes in your container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    mountPoints - The mount points for data volumes in your container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withMountPoints
```
public ContainerDefinition withMountPoints(Collection<MountPoint> mountPoints)
```
    The mount points for data volumes in your container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    mountPoints - The mount points for data volumes in your container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getVolumesFrom
```
public List<VolumeFrom> getVolumesFrom()
```
    Data volumes to mount from another container.
    
    Returns:
    Data volumes to mount from another container.
  - setVolumesFrom
```
public void setVolumesFrom(Collection<VolumeFrom> volumesFrom)
```
    Data volumes to mount from another container.
    
    Parameters:
    volumesFrom - Data volumes to mount from another container.
  - withVolumesFrom
```
public ContainerDefinition withVolumesFrom(VolumeFrom... volumesFrom)
```
    Data volumes to mount from another container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumesFrom - Data volumes to mount from another container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withVolumesFrom
```
public ContainerDefinition withVolumesFrom(Collection<VolumeFrom> volumesFrom)
```
    Data volumes to mount from another container.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    volumesFrom - Data volumes to mount from another container.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public ContainerDefinition clone()
```
    Overrides:
    
    clone in class Object

Class ContainerDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerDefinition

Method Detail

getName

setName

withName

getImage

setImage

withImage

getCpu

setCpu

withCpu

getMemory

setMemory

withMemory

getLinks

setLinks

withLinks

withLinks

getPortMappings

setPortMappings

withPortMappings

withPortMappings

isEssential

setEssential

withEssential

getEssential

getEntryPoint

setEntryPoint

withEntryPoint

withEntryPoint

getCommand

setCommand

withCommand

withCommand

getEnvironment

setEnvironment

withEnvironment

withEnvironment

getMountPoints

setMountPoints

withMountPoints

withMountPoints

getVolumesFrom

setVolumesFrom

withVolumesFrom

withVolumesFrom

toString

hashCode

equals

clone