Class ContainerDefinition
- java.lang.Object
-
- com.amazonaws.services.ecs.model.ContainerDefinition
-
- All Implemented Interfaces:
Serializable,Cloneable
public class ContainerDefinition extends Object implements Serializable, Cloneable
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ContainerDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContainerDefinitionaddDockerLabelsEntry(String key, String value)ContainerDefinitionclearDockerLabelsEntries()Removes all the entries added into DockerLabels.ContainerDefinitionclone()booleanequals(Object obj)List<String>getCommand()The command that is passed to the container.IntegergetCpu()The number ofcpuunits reserved for the container.BooleangetDisableNetworking()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.BooleangetEssential()If theessentialparameter of a container is marked astrue, 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/hostsfile on the container.StringgetHostname()The hostname to use for your container.StringgetImage()The image used to start a container.List<String>getLinks()Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link.LogConfigurationgetLogConfiguration()The log configuration specification for the container.IntegergetMemory()The number of MiB of memory to reserve for the container.List<MountPoint>getMountPoints()The mount points for data volumes in your container.StringgetName()The name of a container.List<PortMapping>getPortMappings()The list of port mappings for the container.BooleangetPrivileged()When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).BooleangetReadonlyRootFilesystem()When this parameter is true, the container is given read-only access to its root file system.List<Ulimit>getUlimits()A list ofulimitsto set in the container.StringgetUser()The user name to use inside the container.List<VolumeFrom>getVolumesFrom()Data volumes to mount from another container.StringgetWorkingDirectory()The working directory in which to run commands inside the container.inthashCode()BooleanisDisableNetworking()When this parameter is true, networking is disabled within the container.BooleanisEssential()If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.BooleanisPrivileged()When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).BooleanisReadonlyRootFilesystem()When this parameter is true, the container is given read-only access to its root file system.voidsetCommand(Collection<String> command)The command that is passed to the container.voidsetCpu(Integer cpu)The number ofcpuunits reserved for the container.voidsetDisableNetworking(Boolean disableNetworking)When this parameter is true, networking is disabled within the container.voidsetDnsSearchDomains(Collection<String> dnsSearchDomains)A list of DNS search domains that are presented to the container.voidsetDnsServers(Collection<String> dnsServers)A list of DNS servers that are presented to the container.voidsetDockerLabels(Map<String,String> dockerLabels)A key/value map of labels to add to the container.voidsetDockerSecurityOptions(Collection<String> dockerSecurityOptions)A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.voidsetEntryPoint(Collection<String> entryPoint)voidsetEnvironment(Collection<KeyValuePair> environment)The environment variables to pass to a container.voidsetEssential(Boolean essential)If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.voidsetExtraHosts(Collection<HostEntry> extraHosts)A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container.voidsetHostname(String hostname)The hostname to use for your container.voidsetImage(String image)The image used to start a container.voidsetLinks(Collection<String> links)Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link.voidsetLogConfiguration(LogConfiguration logConfiguration)The log configuration specification for the container.voidsetMemory(Integer memory)The number of MiB of memory to reserve for the container.voidsetMountPoints(Collection<MountPoint> mountPoints)The mount points for data volumes in your container.voidsetName(String name)The name of a container.voidsetPortMappings(Collection<PortMapping> portMappings)The list of port mappings for the container.voidsetPrivileged(Boolean privileged)When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).voidsetReadonlyRootFilesystem(Boolean readonlyRootFilesystem)When this parameter is true, the container is given read-only access to its root file system.voidsetUlimits(Collection<Ulimit> ulimits)A list ofulimitsto set in the container.voidsetUser(String user)The user name to use inside the container.voidsetVolumesFrom(Collection<VolumeFrom> volumesFrom)Data volumes to mount from another container.voidsetWorkingDirectory(String workingDirectory)The working directory in which to run commands inside the container.StringtoString()Returns a string representation of this object; useful for testing and debugging.ContainerDefinitionwithCommand(String... command)The command that is passed to the container.ContainerDefinitionwithCommand(Collection<String> command)The command that is passed to the container.ContainerDefinitionwithCpu(Integer cpu)The number ofcpuunits reserved for the container.ContainerDefinitionwithDisableNetworking(Boolean disableNetworking)When this parameter is true, networking is disabled within the container.ContainerDefinitionwithDnsSearchDomains(String... dnsSearchDomains)A list of DNS search domains that are presented to the container.ContainerDefinitionwithDnsSearchDomains(Collection<String> dnsSearchDomains)A list of DNS search domains that are presented to the container.ContainerDefinitionwithDnsServers(String... dnsServers)A list of DNS servers that are presented to the container.ContainerDefinitionwithDnsServers(Collection<String> dnsServers)A list of DNS servers that are presented to the container.ContainerDefinitionwithDockerLabels(Map<String,String> dockerLabels)A key/value map of labels to add to the container.ContainerDefinitionwithDockerSecurityOptions(String... dockerSecurityOptions)A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.ContainerDefinitionwithDockerSecurityOptions(Collection<String> dockerSecurityOptions)A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.ContainerDefinitionwithEntryPoint(String... entryPoint)ContainerDefinitionwithEntryPoint(Collection<String> entryPoint)ContainerDefinitionwithEnvironment(KeyValuePair... environment)The environment variables to pass to a container.ContainerDefinitionwithEnvironment(Collection<KeyValuePair> environment)The environment variables to pass to a container.ContainerDefinitionwithEssential(Boolean essential)If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.ContainerDefinitionwithExtraHosts(HostEntry... extraHosts)A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container.ContainerDefinitionwithExtraHosts(Collection<HostEntry> extraHosts)A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container.ContainerDefinitionwithHostname(String hostname)The hostname to use for your container.ContainerDefinitionwithImage(String image)The image used to start a container.ContainerDefinitionwithLinks(String... links)Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link.ContainerDefinitionwithLinks(Collection<String> links)Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link.ContainerDefinitionwithLogConfiguration(LogConfiguration logConfiguration)The log configuration specification for the container.ContainerDefinitionwithMemory(Integer memory)The number of MiB of memory to reserve for the container.ContainerDefinitionwithMountPoints(MountPoint... mountPoints)The mount points for data volumes in your container.ContainerDefinitionwithMountPoints(Collection<MountPoint> mountPoints)The mount points for data volumes in your container.ContainerDefinitionwithName(String name)The name of a container.ContainerDefinitionwithPortMappings(PortMapping... portMappings)The list of port mappings for the container.ContainerDefinitionwithPortMappings(Collection<PortMapping> portMappings)The list of port mappings for the container.ContainerDefinitionwithPrivileged(Boolean privileged)When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).ContainerDefinitionwithReadonlyRootFilesystem(Boolean readonlyRootFilesystem)When this parameter is true, the container is given read-only access to its root file system.ContainerDefinitionwithUlimits(Ulimit... ulimits)A list ofulimitsto set in the container.ContainerDefinitionwithUlimits(Collection<Ulimit> ulimits)A list ofulimitsto set in the container.ContainerDefinitionwithUser(String user)The user name to use inside the container.ContainerDefinitionwithVolumesFrom(VolumeFrom... volumesFrom)Data volumes to mount from another container.ContainerDefinitionwithVolumesFrom(Collection<VolumeFrom> volumesFrom)Data volumes to mount from another container.ContainerDefinitionwithWorkingDirectory(String workingDirectory)The working directory in which to run commands inside the container.
-
-
-
Method Detail
-
setName
public void setName(String name)
The name of a container. If you are linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.- Parameters:
name- The name of a container. If you are linking multiple containers together in a task definition, thenameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.
-
getName
public String getName()
The name of a container. If you are linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.- Returns:
- The name of a container. If you are linking multiple containers
together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.
-
withName
public ContainerDefinition withName(String name)
The name of a container. If you are linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.- Parameters:
name- The name of a container. If you are linking multiple containers together in a task definition, thenameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setImage
public void setImage(String image)
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with
repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
- Parameters:
image- The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified withrepository-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 toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
-
-
-
getImage
public String getImage()
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with
repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
- Returns:
- The image used to start a container. This string is passed
directly to the Docker daemon. Images in the Docker Hub registry
are available by default. Other repositories are specified with
repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
-
-
-
withImage
public ContainerDefinition withImage(String image)
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with
repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
- Parameters:
image- The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified withrepository-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 toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run.-
Images in official repositories on Docker Hub use a single name (for example,
ubuntuormongo). -
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).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setCpu
public void setCpu(Integer cpu)
The number of
cpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
- Parameters:
cpu- The number ofcpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
-
-
-
getCpu
public Integer getCpu()
The number of
cpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
- Returns:
- The number of
cpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
-
-
-
withCpu
public ContainerDefinition withCpu(Integer cpu)
The number of
cpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
- Parameters:
cpu- The number ofcpuunits reserved for the container. A container instance has 1,024cpuunits 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 toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setMemory
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
Memoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.- Parameters:
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 toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.
-
getMemory
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
Memoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.- Returns:
- 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
Memoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.
-
withMemory
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
Memoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.- Parameters:
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 toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLinks
public List<String> getLinks()
The
linkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
- Returns:
- The
linkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
-
setLinks
public void setLinks(Collection<String> links)
The
linkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
- Parameters:
links- Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
-
withLinks
public ContainerDefinition withLinks(String... links)
The
linkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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)orwithLinks(java.util.Collection)if you want to override the existing values.- Parameters:
links- Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLinks
public ContainerDefinition withLinks(Collection<String> links)
The
linkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
- Parameters:
links- Thelinkparameter allows containers to communicate with each other without the need for port mappings, using thenameparameter and optionally, analiasfor the link. This construct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for eachnameandalias. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption todocker 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getPortMappings
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
PortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.- Returns:
- 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
PortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.
-
setPortMappings
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
PortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.- Parameters:
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 toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.
-
withPortMappings
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
PortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.NOTE: This method appends the values to the existing list (if any). Use
setPortMappings(java.util.Collection)orwithPortMappings(java.util.Collection)if you want to override the existing values.- Parameters:
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 toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withPortMappings
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
PortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.- Parameters:
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 toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run.After a task reaches the
RUNNINGstatus, 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 thenetworkBindingssection DescribeTasks responses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEssential
public void setEssential(Boolean essential)
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
- Parameters:
essential- If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
-
getEssential
public Boolean getEssential()
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
- Returns:
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
-
withEssential
public ContainerDefinition withEssential(Boolean essential)
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
- Parameters:
essential- If theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEssential
public Boolean isEssential()
If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
- Returns:
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, 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.
-
getEntryPoint
public List<String> getEntryPoint()
Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.- Returns:
Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
-
setEntryPoint
public void setEntryPoint(Collection<String> entryPoint)
Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.- Parameters:
entryPoint-Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.
-
withEntryPoint
public ContainerDefinition withEntryPoint(String... entryPoint)
Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption 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)orwithEntryPoint(java.util.Collection)if you want to override the existing values.- Parameters:
entryPoint-Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEntryPoint
public ContainerDefinition withEntryPoint(Collection<String> entryPoint)
Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.- Parameters:
entryPoint-Early versions of the Amazon ECS container agent do not properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead.The entry point that is passed to the container. This parameter maps to
Entrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/reference/builder/#entrypoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCommand
public List<String> getCommand()
The command that is passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.- Returns:
- The command that is passed to the container. This parameter maps
to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.
-
setCommand
public void setCommand(Collection<String> command)
The command that is passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.- Parameters:
command- The command that is passed to the container. This parameter maps toCmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.
-
withCommand
public ContainerDefinition withCommand(String... command)
The command that is passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter 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)orwithCommand(java.util.Collection)if you want to override the existing values.- Parameters:
command- The command that is passed to the container. This parameter maps toCmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCommand
public ContainerDefinition withCommand(Collection<String> command)
The command that is passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.- Parameters:
command- The command that is passed to the container. This parameter maps toCmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/reference/builder/#cmd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getEnvironment
public List<KeyValuePair> getEnvironment()
The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
- Returns:
- The environment variables to pass to a container. This parameter
maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
-
setEnvironment
public void setEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
- Parameters:
environment- The environment variables to pass to a container. This parameter maps toEnvin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
-
withEnvironment
public ContainerDefinition withEnvironment(KeyValuePair... environment)
The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption 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)orwithEnvironment(java.util.Collection)if you want to override the existing values.- Parameters:
environment- The environment variables to pass to a container. This parameter maps toEnvin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEnvironment
public ContainerDefinition withEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
- Parameters:
environment- The environment variables to pass to a container. This parameter maps toEnvin the Create a container section of the Docker Remote API and the--envoption to docker run.We do not recommend using plain text environment variables for sensitive information, such as credential data.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getMountPoints
public List<MountPoint> getMountPoints()
The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Returns:
- The mount points for data volumes in your container. This
parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.
-
setMountPoints
public void setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Parameters:
mountPoints- The mount points for data volumes in your container. This parameter maps toVolumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.
-
withMountPoints
public ContainerDefinition withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.NOTE: This method appends the values to the existing list (if any). Use
setMountPoints(java.util.Collection)orwithMountPoints(java.util.Collection)if you want to override the existing values.- Parameters:
mountPoints- The mount points for data volumes in your container. This parameter maps toVolumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withMountPoints
public ContainerDefinition withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Parameters:
mountPoints- The mount points for data volumes in your container. This parameter maps toVolumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVolumesFrom
public List<VolumeFrom> getVolumesFrom()
Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.- Returns:
- Data volumes to mount from another container. This parameter maps
to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.
-
setVolumesFrom
public void setVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.- Parameters:
volumesFrom- Data volumes to mount from another container. This parameter maps toVolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.
-
withVolumesFrom
public ContainerDefinition withVolumesFrom(VolumeFrom... volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.NOTE: This method appends the values to the existing list (if any). Use
setVolumesFrom(java.util.Collection)orwithVolumesFrom(java.util.Collection)if you want to override the existing values.- Parameters:
volumesFrom- Data volumes to mount from another container. This parameter maps toVolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVolumesFrom
public ContainerDefinition withVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.- Parameters:
volumesFrom- Data volumes to mount from another container. This parameter maps toVolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHostname
public void setHostname(String hostname)
The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.- Parameters:
hostname- The hostname to use for your container. This parameter maps toHostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.
-
getHostname
public String getHostname()
The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.- Returns:
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.
-
withHostname
public ContainerDefinition withHostname(String hostname)
The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.- Parameters:
hostname- The hostname to use for your container. This parameter maps toHostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUser
public void setUser(String user)
The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.- Parameters:
user- The user name to use inside the container. This parameter maps toUserin the Create a container section of the Docker Remote API and the--useroption to docker run.
-
getUser
public String getUser()
The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.- Returns:
- The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.
-
withUser
public ContainerDefinition withUser(String user)
The user name to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run.- Parameters:
user- The user name to use inside the container. This parameter maps toUserin the Create a container section of the Docker Remote API and the--useroption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkingDirectory
public void setWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.- Parameters:
workingDirectory- The working directory in which to run commands inside the container. This parameter maps toWorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
-
getWorkingDirectory
public String getWorkingDirectory()
The working directory in which to run commands inside the container. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.- Returns:
- The working directory in which to run commands inside the
container. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
-
withWorkingDirectory
public ContainerDefinition withWorkingDirectory(String workingDirectory)
The working directory in which to run commands inside the container. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.- Parameters:
workingDirectory- The working directory in which to run commands inside the container. This parameter maps toWorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDisableNetworking
public void setDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.- Parameters:
disableNetworking- When this parameter is true, networking is disabled within the container. This parameter maps toNetworkDisabledin the Create a container section of the Docker Remote API.
-
getDisableNetworking
public Boolean getDisableNetworking()
When this parameter is true, networking is disabled within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.- Returns:
- When this parameter is true, networking is disabled within the
container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.
-
withDisableNetworking
public ContainerDefinition withDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is disabled within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.- Parameters:
disableNetworking- When this parameter is true, networking is disabled within the container. This parameter maps toNetworkDisabledin the Create a container section of the Docker Remote API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isDisableNetworking
public Boolean isDisableNetworking()
When this parameter is true, networking is disabled within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.- Returns:
- When this parameter is true, networking is disabled within the
container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API.
-
setPrivileged
public void setPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.- Parameters:
privileged- When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.
-
getPrivileged
public Boolean getPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.- Returns:
- When this parameter is true, the container is given elevated
privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.
-
withPrivileged
public ContainerDefinition withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.- Parameters:
privileged- When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isPrivileged
public Boolean isPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.- Returns:
- When this parameter is true, the container is given elevated
privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run.
-
setReadonlyRootFilesystem
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
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.- Parameters:
readonlyRootFilesystem- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.
-
getReadonlyRootFilesystem
public Boolean getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.- Returns:
- When this parameter is true, the container is given read-only
access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.
-
withReadonlyRootFilesystem
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
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.- Parameters:
readonlyRootFilesystem- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isReadonlyRootFilesystem
public Boolean isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.- Returns:
- When this parameter is true, the container is given read-only
access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.
-
getDnsServers
public List<String> getDnsServers()
A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.- Returns:
- A list of DNS servers that are presented to the container. This
parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.
-
setDnsServers
public void setDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.- Parameters:
dnsServers- A list of DNS servers that are presented to the container. This parameter maps toDnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.
-
withDnsServers
public ContainerDefinition withDnsServers(String... dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.NOTE: This method appends the values to the existing list (if any). Use
setDnsServers(java.util.Collection)orwithDnsServers(java.util.Collection)if you want to override the existing values.- Parameters:
dnsServers- A list of DNS servers that are presented to the container. This parameter maps toDnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDnsServers
public ContainerDefinition withDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.- Parameters:
dnsServers- A list of DNS servers that are presented to the container. This parameter maps toDnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDnsSearchDomains
public List<String> getDnsSearchDomains()
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.- Returns:
- A list of DNS search domains that are presented to the container.
This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.
-
setDnsSearchDomains
public void setDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.- Parameters:
dnsSearchDomains- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.
-
withDnsSearchDomains
public ContainerDefinition withDnsSearchDomains(String... dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.NOTE: This method appends the values to the existing list (if any). Use
setDnsSearchDomains(java.util.Collection)orwithDnsSearchDomains(java.util.Collection)if you want to override the existing values.- Parameters:
dnsSearchDomains- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDnsSearchDomains
public ContainerDefinition withDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.- Parameters:
dnsSearchDomains- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getExtraHosts
public List<HostEntry> getExtraHosts()
A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.- Returns:
- A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.
-
setExtraHosts
public void setExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.- Parameters:
extraHosts- A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.
-
withExtraHosts
public ContainerDefinition withExtraHosts(HostEntry... extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.NOTE: This method appends the values to the existing list (if any). Use
setExtraHosts(java.util.Collection)orwithExtraHosts(java.util.Collection)if you want to override the existing values.- Parameters:
extraHosts- A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withExtraHosts
public ContainerDefinition withExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.- Parameters:
extraHosts- A list of hostnames and IP address mappings to append to the/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDockerSecurityOptions
public List<String> getDockerSecurityOptions()
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.- Returns:
- A list of strings to provide custom labels for SELinux and
AppArmor multi-level security systems. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.
-
setDockerSecurityOptions
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
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.- Parameters:
dockerSecurityOptions- A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps toSecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.
-
withDockerSecurityOptions
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
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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)orwithDockerSecurityOptions(java.util.Collection)if you want to override the existing values.- Parameters:
dockerSecurityOptions- A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps toSecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDockerSecurityOptions
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
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.- Parameters:
dockerSecurityOptions- A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps toSecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDockerLabels
public Map<String,String> getDockerLabels()
A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption 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"- Returns:
- A key/value map of labels to add to the container. This parameter
maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption 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"
-
setDockerLabels
public void setDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption 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"- Parameters:
dockerLabels- A key/value map of labels to add to the container. This parameter maps toLabelsin the Create a container section of the Docker Remote API and the--labeloption 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"
-
withDockerLabels
public ContainerDefinition withDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption 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"- Parameters:
dockerLabels- A key/value map of labels to add to the container. This parameter maps toLabelsin the Create a container section of the Docker Remote API and the--labeloption 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"- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addDockerLabelsEntry
public ContainerDefinition addDockerLabelsEntry(String key, String value)
-
clearDockerLabelsEntries
public ContainerDefinition clearDockerLabelsEntries()
Removes all the entries added into DockerLabels. <p> Returns a reference to this object so that method calls can be chained together.
-
getUlimits
public List<Ulimit> getUlimits()
A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"- Returns:
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"
-
setUlimits
public void setUlimits(Collection<Ulimit> ulimits)
A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"- Parameters:
ulimits- A list ofulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"
-
withUlimits
public ContainerDefinition withUlimits(Ulimit... ulimits)
A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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)orwithUlimits(java.util.Collection)if you want to override the existing values.- Parameters:
ulimits- A list ofulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withUlimits
public ContainerDefinition withUlimits(Collection<Ulimit> ulimits)
A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"- Parameters:
ulimits- A list ofulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption 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"- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLogConfiguration
public void setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.- Parameters:
logConfiguration- The log configuration specification for the container. This parameter maps toLogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.
-
getLogConfiguration
public LogConfiguration getLogConfiguration()
The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.- Returns:
- The log configuration specification for the container. This
parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.
-
withLogConfiguration
public ContainerDefinition withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.- Parameters:
logConfiguration- The log configuration specification for the container. This parameter maps toLogConfigin the Create a container section of the Docker Remote API and the--log-driveroption 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_DRIVERSenvironment 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ContainerDefinition clone()
-
-