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.
Constructor and Description |
---|
ContainerDefinition() |
Modifier and Type | Method and Description |
---|---|
ContainerDefinition |
addDockerLabelsEntry(String key,
String value) |
ContainerDefinition |
clearDockerLabelsEntries()
Removes all the entries added into DockerLabels.
|
ContainerDefinition |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCommand()
The command that is passed to the container.
|
Integer |
getCpu()
The number of
cpu units reserved for the container. |
Boolean |
getDisableNetworking()
When this parameter is true, networking is disabled within the container.
|
List<String> |
getDnsSearchDomains()
A list of DNS search domains that are presented to the container.
|
List<String> |
getDnsServers()
A list of DNS servers that are presented to the container.
|
Map<String,String> |
getDockerLabels()
A key/value map of labels to add to the container.
|
List<String> |
getDockerSecurityOptions()
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems.
|
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 , and that container fails or stops for any reason, all
other containers that are part of the task are stopped. |
List<HostEntry> |
getExtraHosts()
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
String |
getHostname()
The hostname to use for your container.
|
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 and optionally, an alias for the
link. |
LogConfiguration |
getLogConfiguration()
The log configuration specification for the container.
|
Integer |
getMemory()
The number of MiB of memory to reserve 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.
|
Boolean |
getPrivileged()
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the
root user). |
Boolean |
getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to
its root file system.
|
List<Ulimit> |
getUlimits()
A list of
ulimits to set in the container. |
String |
getUser()
The user name to use inside the container.
|
List<VolumeFrom> |
getVolumesFrom()
Data volumes to mount from another container.
|
String |
getWorkingDirectory()
The working directory in which to run commands inside the container.
|
int |
hashCode() |
Boolean |
isDisableNetworking()
When this parameter is true, networking is disabled within the container.
|
Boolean |
isEssential()
If the
essential parameter of a container is marked as
true , and that container fails or stops for any reason, all
other containers that are part of the task are stopped. |
Boolean |
isPrivileged()
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the
root user). |
Boolean |
isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to
its root file system.
|
void |
setCommand(Collection<String> command)
The command that is passed to the container.
|
void |
setCpu(Integer cpu)
The number of
cpu units reserved for the container. |
void |
setDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container.
|
void |
setDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
void |
setDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container.
|
void |
setDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container.
|
void |
setDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems.
|
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 , and that container fails or stops for any reason, all
other containers that are part of the task are stopped. |
void |
setExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
void |
setHostname(String hostname)
The hostname to use for your container.
|
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 and optionally, an alias for the
link. |
void |
setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
void |
setMemory(Integer memory)
The number of MiB of memory to reserve 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 |
setPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the
root user). |
void |
setReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to
its root file system.
|
void |
setUlimits(Collection<Ulimit> ulimits)
A list of
ulimits to set in the container. |
void |
setUser(String user)
The user name to use inside the container.
|
void |
setVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container.
|
void |
setWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ContainerDefinition |
withCommand(Collection<String> command)
The command that is passed to the container.
|
ContainerDefinition |
withCommand(String... command)
The command that is passed to the container.
|
ContainerDefinition |
withCpu(Integer cpu)
The number of
cpu units reserved for the container. |
ContainerDefinition |
withDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container.
|
ContainerDefinition |
withDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
ContainerDefinition |
withDnsSearchDomains(String... dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
ContainerDefinition |
withDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container.
|
ContainerDefinition |
withDnsServers(String... dnsServers)
A list of DNS servers that are presented to the container.
|
ContainerDefinition |
withDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container.
|
ContainerDefinition |
withDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems.
|
ContainerDefinition |
withDockerSecurityOptions(String... dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems.
|
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 , and that container fails or stops for any reason, all
other containers that are part of the task are stopped. |
ContainerDefinition |
withExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
ContainerDefinition |
withExtraHosts(HostEntry... extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
ContainerDefinition |
withHostname(String hostname)
The hostname to use for your container.
|
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 and optionally, an alias for the
link. |
ContainerDefinition |
withLinks(String... links)
The
link parameter allows containers to communicate with
each other without the need for port mappings, using the
name parameter and optionally, an alias for the
link. |
ContainerDefinition |
withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
ContainerDefinition |
withMemory(Integer memory)
The number of MiB of memory to reserve 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 |
withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the
root user). |
ContainerDefinition |
withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to
its root file system.
|
ContainerDefinition |
withUlimits(Collection<Ulimit> ulimits)
A list of
ulimits to set in the container. |
ContainerDefinition |
withUlimits(Ulimit... ulimits)
A list of
ulimits to set in the container. |
ContainerDefinition |
withUser(String user)
The user name to use inside 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.
|
ContainerDefinition |
withWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container.
|
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. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This parameter maps to
name
in the Create a container section of the Docker Remote API and the --name
option to docker run.
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. Up to 255 letters (uppercase
and lowercase), numbers, hyphens, and underscores are allowed.
This parameter maps to name
in the Create a container section of the Docker Remote API and the --name
option to docker
run.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. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This parameter maps to
name
in the Create a container section of the Docker Remote API and the --name
option to docker run.
name
of one
container can be entered in the links
of another
container to connect the containers. Up to 255 letters (uppercase
and lowercase), numbers, hyphens, and underscores are allowed.
This parameter maps to name
in the Create a container section of the Docker Remote API and the --name
option to docker
run.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. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This parameter maps to
name
in the Create a container section of the Docker Remote API and the --name
option to docker run.
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. Up to 255 letters (uppercase
and lowercase), numbers, hyphens, and underscores are allowed.
This parameter maps to name
in the Create a container section of the Docker Remote API and the --name
option to docker
run.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
. Up to 255
letters (uppercase and lowercase), numbers, hyphens, underscores, colons,
periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker run.
Images in official repositories on Docker Hub use a single name (for
example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain
name (for example, quay.io/assemblyline/ubuntu
).
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
. Up
to 255 letters (uppercase and lowercase), numbers, hyphens,
underscores, colons, periods, forward slashes, and number signs
are allowed. This parameter maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker
run.
Images in official repositories on Docker Hub use a single name
(for example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a
domain name (for example, quay.io/assemblyline/ubuntu
).
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
. Up to 255
letters (uppercase and lowercase), numbers, hyphens, underscores, colons,
periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker run.
Images in official repositories on Docker Hub use a single name (for
example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain
name (for example, quay.io/assemblyline/ubuntu
).
repository-url/image:tag
. Up
to 255 letters (uppercase and lowercase), numbers, hyphens,
underscores, colons, periods, forward slashes, and number signs
are allowed. This parameter maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker
run.
Images in official repositories on Docker Hub use a single name
(for example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a
domain name (for example,
quay.io/assemblyline/ubuntu
).
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
. Up to 255
letters (uppercase and lowercase), numbers, hyphens, underscores, colons,
periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker run.
Images in official repositories on Docker Hub use a single name (for
example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain
name (for example, quay.io/assemblyline/ubuntu
).
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
. Up
to 255 letters (uppercase and lowercase), numbers, hyphens,
underscores, colons, periods, forward slashes, and number signs
are allowed. This parameter maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker
run.
Images in official repositories on Docker Hub use a single name
(for example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an
organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a
domain name (for example, quay.io/assemblyline/ubuntu
).
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.
This parameter specifies the minimum amount of CPU to reserve for a
container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated amount.
This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
cpu
- The number of cpu
units reserved for the container. A
container instance has 1,024 cpu
units for every CPU
core. This parameter specifies the minimum amount of CPU to
reserve for a container, and containers share unallocated CPU
units with other containers on the instance with the same ratio as
their allocated amount. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to
docker
run. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
public Integer getCpu()
The number of cpu
units reserved for the container. A
container instance has 1,024 cpu
units for every CPU core.
This parameter specifies the minimum amount of CPU to reserve for a
container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated amount.
This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
cpu
units reserved for the container.
A container instance has 1,024 cpu
units for every
CPU core. This parameter specifies the minimum amount of CPU to
reserve for a container, and containers share unallocated CPU
units with other containers on the instance with the same ratio
as their allocated amount. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option
to
docker run. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
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.
This parameter specifies the minimum amount of CPU to reserve for a
container, and containers share unallocated CPU units with other
containers on the instance with the same ratio as their allocated amount.
This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
cpu
- The number of cpu
units reserved for the container. A
container instance has 1,024 cpu
units for every CPU
core. This parameter specifies the minimum amount of CPU to
reserve for a container, and containers share unallocated CPU
units with other containers on the instance with the same ratio as
their allocated amount. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to
docker
run. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
public void setMemory(Integer memory)
The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon reserves
a minimum of 4 MiB of memory for a container, so you should not specify
fewer than 4 MiB of memory for your containers. If your container
attempts to exceed the memory allocated here, the container is killed.
This parameter maps to Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker run.
memory
- The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon
reserves a minimum of 4 MiB of memory for a container, so you
should not specify fewer than 4 MiB of memory for your containers.
If your container attempts to exceed the memory allocated here,
the container is killed. This parameter maps to
Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker
run.public Integer getMemory()
The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon reserves
a minimum of 4 MiB of memory for a container, so you should not specify
fewer than 4 MiB of memory for your containers. If your container
attempts to exceed the memory allocated here, the container is killed.
This parameter maps to Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker run.
Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker
run.public ContainerDefinition withMemory(Integer memory)
The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon reserves
a minimum of 4 MiB of memory for a container, so you should not specify
fewer than 4 MiB of memory for your containers. If your container
attempts to exceed the memory allocated here, the container is killed.
This parameter maps to Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker run.
memory
- The number of MiB of memory to reserve for the container. You must
specify a non-zero integer for this parameter; the Docker daemon
reserves a minimum of 4 MiB of memory for a container, so you
should not specify fewer than 4 MiB of memory for your containers.
If your container attempts to exceed the memory allocated here,
the container is killed. This parameter maps to
Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker
run.public List<String> getLinks()
The link
parameter allows containers to communicate with
each other without the need for port mappings, using the
name
parameter and optionally, an alias
for the
link. This construct is analogous to name:alias
in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name
and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
link
parameter allows containers to communicate
with each other without the need for port mappings, using the
name
parameter and optionally, an alias
for the link. This construct is analogous to
name:alias
in Docker links. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are
allowed for each name
and alias
. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This
parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
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 and optionally, an alias
for the
link. This construct is analogous to name:alias
in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name
and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
links
- The link
parameter allows containers to communicate
with each other without the need for port mappings, using the
name
parameter and optionally, an alias
for the link. This construct is analogous to
name:alias
in Docker links. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are
allowed for each name
and alias
. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This
parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
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 and optionally, an alias
for the
link. This construct is analogous to name:alias
in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name
and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
NOTE: This method appends the values to the existing list (if
any). Use setLinks(java.util.Collection)
or
withLinks(java.util.Collection)
if you want to override the
existing values.
links
- The link
parameter allows containers to communicate
with each other without the need for port mappings, using the
name
parameter and optionally, an alias
for the link. This construct is analogous to
name:alias
in Docker links. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are
allowed for each name
and alias
. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This
parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
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 and optionally, an alias
for the
link. This construct is analogous to name:alias
in Docker
links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed for each name
and alias
. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps
to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
links
- The link
parameter allows containers to communicate
with each other without the need for port mappings, using the
name
parameter and optionally, an alias
for the link. This construct is analogous to
name:alias
in Docker links. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, and underscores are
allowed for each name
and alias
. For
more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This
parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to
docker run
. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
public List<PortMapping> getPortMappings()
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings
in the
Create a container section of the Docker Remote API and the --publish
option to docker run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to
docker run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a
selected task in the Amazon ECS console, or the
networkBindings
section DescribeTasks
responses.
public void setPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings
in the
Create a container section of the Docker Remote API and the --publish
option to docker run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
portMappings
- The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send
or receive traffic. This parameter maps to
PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to docker
run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a
selected task in the Amazon ECS console, or the
networkBindings
section DescribeTasks
responses.
public ContainerDefinition withPortMappings(PortMapping... portMappings)
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings
in the
Create a container section of the Docker Remote API and the --publish
option to docker run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
NOTE: This method appends the values to the existing list (if
any). Use setPortMappings(java.util.Collection)
or
withPortMappings(java.util.Collection)
if you want to override
the existing values.
portMappings
- The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send
or receive traffic. This parameter maps to
PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to docker
run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a
selected task in the Amazon ECS console, or the
networkBindings
section DescribeTasks
responses.
public ContainerDefinition withPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send or
receive traffic. This parameter maps to PortBindings
in the
Create a container section of the Docker Remote API and the --publish
option to docker run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a selected
task in the Amazon ECS console, or the networkBindings
section DescribeTasks responses.
portMappings
- The list of port mappings for the container. Port mappings allow
containers to access ports on the host container instance to send
or receive traffic. This parameter maps to
PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to docker
run.
After a task reaches the RUNNING
status, manual and
automatic host and container port assignments are visible in the
Network Bindings section of a container description of a
selected task in the Amazon ECS console, or the
networkBindings
section DescribeTasks
responses.
public void setEssential(Boolean essential)
If the essential
parameter of a container is marked as
true
, and that container fails or stops for any reason, all
other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as
false
, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
essential
- If the essential
parameter of a container is marked
as true
, and that container fails or stops for any
reason, all other containers that are part of the task are
stopped. If the essential
parameter of a container is
marked as false
, then its failure does not affect the
rest of the containers in a task. If this parameter is omitted, a
container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
public Boolean getEssential()
If the essential
parameter of a container is marked as
true
, and that container fails or stops for any reason, all
other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as
false
, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
essential
parameter of a container is marked
as true
, and that container fails or stops for any
reason, all other containers that are part of the task are
stopped. If the essential
parameter of a container
is marked as false
, then its failure does not affect
the rest of the containers in a task. If this parameter is
omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
public ContainerDefinition withEssential(Boolean essential)
If the essential
parameter of a container is marked as
true
, and that container fails or stops for any reason, all
other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as
false
, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
essential
- If the essential
parameter of a container is marked
as true
, and that container fails or stops for any
reason, all other containers that are part of the task are
stopped. If the essential
parameter of a container is
marked as false
, then its failure does not affect the
rest of the containers in a task. If this parameter is omitted, a
container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
public Boolean isEssential()
If the essential
parameter of a container is marked as
true
, and that container fails or stops for any reason, all
other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as
false
, then its failure does not affect the rest of the
containers in a task. If this parameter is omitted, a container is
assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
essential
parameter of a container is marked
as true
, and that container fails or stops for any
reason, all other containers that are part of the task are
stopped. If the essential
parameter of a container
is marked as false
, then its failure does not affect
the rest of the containers in a task. If this parameter is
omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.
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 entry point that is passed to the container. This parameter maps to
Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run.
For more information, see https://docs.docker.com/reference/builder/#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 entry point that is passed to the container. This parameter
maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option
to
docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
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 entry point that is passed to the container. This parameter maps to
Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run.
For more information, see https://docs.docker.com/reference/builder/#entrypoint.
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 entry point that is passed to the container. This parameter
maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to
docker
run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
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 entry point that is passed to the container. This parameter maps to
Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run.
For more information, see https://docs.docker.com/reference/builder/#entrypoint.
NOTE: This method appends the values to the existing list (if
any). Use setEntryPoint(java.util.Collection)
or
withEntryPoint(java.util.Collection)
if you want to override the
existing values.
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 entry point that is passed to the container. This parameter
maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to
docker
run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
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 entry point that is passed to the container. This parameter maps to
Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run.
For more information, see https://docs.docker.com/reference/builder/#entrypoint.
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 entry point that is passed to the container. This parameter
maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to
docker
run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
public List<String> getCommand()
The command that is passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to
docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.public void setCommand(Collection<String> command)
The command that is passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
command
- The command that is passed to the container. This parameter maps
to Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to
docker
run. For more information, see https://docs.docker.com/reference/builder/#cmd.public ContainerDefinition withCommand(String... command)
The command that is passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
NOTE: This method appends the values to the existing list (if
any). Use setCommand(java.util.Collection)
or
withCommand(java.util.Collection)
if you want to override the
existing values.
command
- The command that is passed to the container. This parameter maps
to Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to
docker
run. For more information, see https://docs.docker.com/reference/builder/#cmd.public ContainerDefinition withCommand(Collection<String> command)
The command that is passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run.
For more information, see https://docs.docker.com/reference/builder/#cmd.
command
- The command that is passed to the container. This parameter maps
to Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to
docker
run. For more information, see https://docs.docker.com/reference/builder/#cmd.public List<KeyValuePair> getEnvironment()
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
Env
in the Create a container section of the Docker Remote API and the --env
option to docker
run. We do not recommend using plain text environment variables for sensitive information, such as credential data.
public void setEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
environment
- The environment variables to pass to a container. This parameter
maps to Env
in the Create a container section of the Docker Remote API and the --env
option to docker
run. We do not recommend using plain text environment variables for sensitive information, such as credential data.
public ContainerDefinition withEnvironment(KeyValuePair... environment)
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
NOTE: This method appends the values to the existing list (if
any). Use setEnvironment(java.util.Collection)
or
withEnvironment(java.util.Collection)
if you want to override
the existing values.
environment
- The environment variables to pass to a container. This parameter
maps to Env
in the Create a container section of the Docker Remote API and the --env
option to docker
run. We do not recommend using plain text environment variables for sensitive information, such as credential data.
public ContainerDefinition withEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plain text environment variables for sensitive information, such as credential data.
environment
- The environment variables to pass to a container. This parameter
maps to Env
in the Create a container section of the Docker Remote API and the --env
option to docker
run. We do not recommend using plain text environment variables for sensitive information, such as credential data.
public List<MountPoint> getMountPoints()
The mount points for data volumes in your container. This parameter maps
to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker
run.public void setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container. This parameter maps
to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
mountPoints
- The mount points for data volumes in your container. This
parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker
run.public ContainerDefinition withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container. This parameter maps
to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
NOTE: This method appends the values to the existing list (if
any). Use setMountPoints(java.util.Collection)
or
withMountPoints(java.util.Collection)
if you want to override
the existing values.
mountPoints
- The mount points for data volumes in your container. This
parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker
run.public ContainerDefinition withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container. This parameter maps
to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
mountPoints
- The mount points for data volumes in your container. This
parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker
run.public List<VolumeFrom> getVolumesFrom()
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option
to
docker run.public void setVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
volumesFrom
- Data volumes to mount from another container. This parameter maps
to VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option
to docker
run.public ContainerDefinition withVolumesFrom(VolumeFrom... volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
NOTE: This method appends the values to the existing list (if
any). Use setVolumesFrom(java.util.Collection)
or
withVolumesFrom(java.util.Collection)
if you want to override
the existing values.
volumesFrom
- Data volumes to mount from another container. This parameter maps
to VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option
to docker
run.public ContainerDefinition withVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
volumesFrom
- Data volumes to mount from another container. This parameter maps
to VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option
to docker
run.public void setHostname(String hostname)
The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to docker run.
hostname
- The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to
docker
run.public String getHostname()
The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to docker run.
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to
docker run.public ContainerDefinition withHostname(String hostname)
The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to docker run.
hostname
- The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to
docker
run.public void setUser(String user)
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the --user
option to docker run.
user
- The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the --user
option to docker
run.public String getUser()
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the --user
option to docker run.
User
in the Create a container section of the Docker Remote API and the --user
option to docker
run.public ContainerDefinition withUser(String user)
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the --user
option to docker run.
user
- The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the --user
option to docker
run.public void setWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container. This
parameter maps to WorkingDir
in the Create a container section of the Docker Remote API and the --workdir
option to docker run.
workingDirectory
- The working directory in which to run commands inside the
container. This parameter maps to WorkingDir
in the
Create a container section of the Docker Remote API and the --workdir
option to docker
run.public String getWorkingDirectory()
The working directory in which to run commands inside the container. This
parameter maps to WorkingDir
in the Create a container section of the Docker Remote API and the --workdir
option to docker run.
WorkingDir
in the
Create a container section of the Docker Remote API and the --workdir
option to
docker run.public ContainerDefinition withWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container. This
parameter maps to WorkingDir
in the Create a container section of the Docker Remote API and the --workdir
option to docker run.
workingDirectory
- The working directory in which to run commands inside the
container. This parameter maps to WorkingDir
in the
Create a container section of the Docker Remote API and the --workdir
option to docker
run.public void setDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
disableNetworking
- When this parameter is true, networking is disabled within the
container. This parameter maps to NetworkDisabled
in
the Create a container section of the Docker Remote API.public Boolean getDisableNetworking()
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
NetworkDisabled
in
the Create a container section of the Docker Remote API.public ContainerDefinition withDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
disableNetworking
- When this parameter is true, networking is disabled within the
container. This parameter maps to NetworkDisabled
in
the Create a container section of the Docker Remote API.public Boolean isDisableNetworking()
When this parameter is true, networking is disabled within the container.
This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
NetworkDisabled
in
the Create a container section of the Docker Remote API.public void setPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root
user).
This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
privileged
- When this parameter is true, the container is given elevated
privileges on the host container instance (similar to the
root
user). This parameter maps to
Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to
docker
run.public Boolean getPrivileged()
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root
user).
This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
root
user). This parameter maps to
Privileged
in the Create a container section of the Docker Remote API and the --privileged
option
to
docker run.public ContainerDefinition withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root
user).
This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
privileged
- When this parameter is true, the container is given elevated
privileges on the host container instance (similar to the
root
user). This parameter maps to
Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to
docker
run.public Boolean isPrivileged()
When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root
user).
This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
root
user). This parameter maps to
Privileged
in the Create a container section of the Docker Remote API and the --privileged
option
to
docker run.public void setReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.
readonlyRootFilesystem
- When this parameter is true, the container is given read-only
access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.public Boolean getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.public ContainerDefinition withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.
readonlyRootFilesystem
- When this parameter is true, the container is given read-only
access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.public Boolean isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to
its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to
docker run
.public List<String> getDnsServers()
A list of DNS servers that are presented to the container. This parameter
maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker
run.public void setDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter
maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
dnsServers
- A list of DNS servers that are presented to the container. This
parameter maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker
run.public ContainerDefinition withDnsServers(String... dnsServers)
A list of DNS servers that are presented to the container. This parameter
maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
NOTE: This method appends the values to the existing list (if
any). Use setDnsServers(java.util.Collection)
or
withDnsServers(java.util.Collection)
if you want to override the
existing values.
dnsServers
- A list of DNS servers that are presented to the container. This
parameter maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker
run.public ContainerDefinition withDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter
maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
dnsServers
- A list of DNS servers that are presented to the container. This
parameter maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker
run.public List<String> getDnsSearchDomains()
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option
to
docker run.public void setDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
dnsSearchDomains
- A list of DNS search domains that are presented to the container.
This parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to
docker
run.public ContainerDefinition withDnsSearchDomains(String... dnsSearchDomains)
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
NOTE: This method appends the values to the existing list (if
any). Use setDnsSearchDomains(java.util.Collection)
or
withDnsSearchDomains(java.util.Collection)
if you want to
override the existing values.
dnsSearchDomains
- A list of DNS search domains that are presented to the container.
This parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to
docker
run.public ContainerDefinition withDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This
parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
dnsSearchDomains
- A list of DNS search domains that are presented to the container.
This parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to
docker
run.public List<HostEntry> getExtraHosts()
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps to
ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
/etc/hosts
file on the container. This parameter
maps to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to
docker run.public void setExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps to
ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
extraHosts
- A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps
to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to
docker
run.public ContainerDefinition withExtraHosts(HostEntry... extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps to
ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
NOTE: This method appends the values to the existing list (if
any). Use setExtraHosts(java.util.Collection)
or
withExtraHosts(java.util.Collection)
if you want to override the
existing values.
extraHosts
- A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps
to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to
docker
run.public ContainerDefinition withExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps to
ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
extraHosts
- A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps
to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to
docker
run.public List<String> getDockerSecurityOptions()
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option
to
docker run.
The Amazon ECS container agent running on a container instance
must register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon
EC2 Container Service Developer Guide.
public void setDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
dockerSecurityOptions
- A list of strings to provide custom labels for SELinux and
AppArmor multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option
to docker
run.
The Amazon ECS container agent running on a container instance
must register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
public ContainerDefinition withDockerSecurityOptions(String... dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
NOTE: This method appends the values to the existing list (if
any). Use setDockerSecurityOptions(java.util.Collection)
or
withDockerSecurityOptions(java.util.Collection)
if you want to
override the existing values.
dockerSecurityOptions
- A list of strings to provide custom labels for SELinux and
AppArmor multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option
to docker
run.
The Amazon ECS container agent running on a container instance
must register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
public ContainerDefinition withDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must
register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For
more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
dockerSecurityOptions
- A list of strings to provide custom labels for SELinux and
AppArmor multi-level security systems. This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option
to docker
run.
The Amazon ECS container agent running on a container instance
must register with the ECS_SELINUX_CAPABLE=true
or
ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
public Map<String,String> getDockerLabels()
A key/value map of labels to add to the container. This parameter maps to
Labels
in the Create a container section of the Docker Remote API and the --label
option to docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
Labels
in the Create a container section of the Docker Remote API and the --label
option to docker
run. This parameter requires version 1.18 of the Docker
Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
public void setDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to
Labels
in the Create a container section of the Docker Remote API and the --label
option to docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
dockerLabels
- A key/value map of labels to add to the container. This parameter
maps to Labels
in the Create a container section of the Docker Remote API and the --label
option to docker
run. This parameter requires version 1.18 of the Docker Remote
API or greater on your container instance. To check the Docker
Remote API version on your container instance, log into your
container instance and run the following command:
sudo docker version | grep "Server API version"
public ContainerDefinition withDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to
Labels
in the Create a container section of the Docker Remote API and the --label
option to docker run.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
dockerLabels
- A key/value map of labels to add to the container. This parameter
maps to Labels
in the Create a container section of the Docker Remote API and the --label
option to docker
run. This parameter requires version 1.18 of the Docker Remote
API or greater on your container instance. To check the Docker
Remote API version on your container instance, log into your
container instance and run the following command:
sudo docker version | grep "Server API version"
public ContainerDefinition addDockerLabelsEntry(String key, String value)
public ContainerDefinition clearDockerLabelsEntries()
public List<Ulimit> getUlimits()
A list of ulimits
to set in the container. This parameter
maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
ulimits
to set in the container. This
parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker
run. Valid naming values are displayed in the Ulimit
data type. This parameter requires version 1.18 of the Docker
Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
public void setUlimits(Collection<Ulimit> ulimits)
A list of ulimits
to set in the container. This parameter
maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
ulimits
- A list of ulimits
to set in the container. This
parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker
run. Valid naming values are displayed in the Ulimit
data type. This parameter requires version 1.18 of the Docker
Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
public ContainerDefinition withUlimits(Ulimit... ulimits)
A list of ulimits
to set in the container. This parameter
maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
NOTE: This method appends the values to the existing list (if
any). Use setUlimits(java.util.Collection)
or
withUlimits(java.util.Collection)
if you want to override the
existing values.
ulimits
- A list of ulimits
to set in the container. This
parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker
run. Valid naming values are displayed in the Ulimit
data type. This parameter requires version 1.18 of the Docker
Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
public ContainerDefinition withUlimits(Collection<Ulimit> ulimits)
A list of ulimits
to set in the container. This parameter
maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run.
Valid naming values are displayed in the Ulimit data type. This
parameter requires version 1.18 of the Docker Remote API or greater on
your container instance. To check the Docker Remote API version on your
container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
ulimits
- A list of ulimits
to set in the container. This
parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker
run. Valid naming values are displayed in the Ulimit
data type. This parameter requires version 1.18 of the Docker
Remote API or greater on your container instance. To check the
Docker Remote API version on your container instance, log into
your container instance and run the following command:
sudo docker version | grep "Server API version"
public void setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container. This parameter
maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run.
By default, containers use the same logging driver that the Docker daemon
uses; however the container may use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see Configure
logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before
containers placed on that instance can use these log configuration
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
logConfiguration
- The log configuration specification for the container. This
parameter maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to
docker
run. By default, containers use the same logging driver that
the Docker daemon uses; however the container may use a different
logging driver than the Docker daemon by specifying a log driver
with this parameter in the container definition. To use a
different logging driver for a container, the log system must be
configured properly on the container instance (or on a different
log server for remote logging options). For more information on
the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or
greater on your container instance. To check the Docker Remote API
version on your container instance, log into your container
instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance
must register the logging drivers available on that instance with
the ECS_AVAILABLE_LOGGING_DRIVERS
environment
variable before containers placed on that instance can use these
log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
public LogConfiguration getLogConfiguration()
The log configuration specification for the container. This parameter
maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run.
By default, containers use the same logging driver that the Docker daemon
uses; however the container may use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see Configure
logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before
containers placed on that instance can use these log configuration
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option
to
docker run. By default, containers use the same logging
driver that the Docker daemon uses; however the container may use
a different logging driver than the Docker daemon by specifying a
log driver with this parameter in the container definition. To
use a different logging driver for a container, the log system
must be configured properly on the container instance (or on a
different log server for remote logging options). For more
information on the options for different supported log drivers,
see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or
greater on your container instance. To check the Docker Remote
API version on your container instance, log into your container
instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance
must register the logging drivers available on that instance with
the ECS_AVAILABLE_LOGGING_DRIVERS
environment
variable before containers placed on that instance can use these
log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon
EC2 Container Service Developer Guide.
public ContainerDefinition withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container. This parameter
maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run.
By default, containers use the same logging driver that the Docker daemon
uses; however the container may use a different logging driver than the
Docker daemon by specifying a log driver with this parameter in the
container definition. To use a different logging driver for a container,
the log system must be configured properly on the container instance (or
on a different log server for remote logging options). For more
information on the options for different supported log drivers, see Configure
logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater
on your container instance. To check the Docker Remote API version on
your container instance, log into your container instance and run the
following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must
register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before
containers placed on that instance can use these log configuration
options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
logConfiguration
- The log configuration specification for the container. This
parameter maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to
docker
run. By default, containers use the same logging driver that
the Docker daemon uses; however the container may use a different
logging driver than the Docker daemon by specifying a log driver
with this parameter in the container definition. To use a
different logging driver for a container, the log system must be
configured properly on the container instance (or on a different
log server for remote logging options). For more information on
the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or
greater on your container instance. To check the Docker Remote API
version on your container instance, log into your container
instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance
must register the logging drivers available on that instance with
the ECS_AVAILABLE_LOGGING_DRIVERS
environment
variable before containers placed on that instance can use these
log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2
Container Service Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public ContainerDefinition clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.