@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ContainerDefinition extends Object implements Serializable, Cloneable, StructuredPojo
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
Constructor and Description |
---|
ContainerDefinition() |
Modifier and Type | Method and Description |
---|---|
ContainerDefinition |
addDockerLabelsEntry(String key,
String value)
Add a single DockerLabels entry
|
ContainerDefinition |
clearDockerLabelsEntries()
Removes all the entries added into DockerLabels.
|
ContainerDefinition |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCommand()
The command that's passed to the container.
|
Integer |
getCpu()
The number of
cpu units reserved for the container. |
List<String> |
getCredentialSpecs()
A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec ) file that configures the
container for Active Directory authentication. |
List<ContainerDependency> |
getDependsOn()
The dependencies defined for container startup and shutdown.
|
Boolean |
getDisableNetworking()
When this parameter is true, networking is off 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 configuration for multiple security systems.
|
List<String> |
getEntryPoint()
|
List<KeyValuePair> |
getEnvironment()
The environment variables to pass to a container.
|
List<EnvironmentFile> |
getEnvironmentFiles()
A list of files containing the environment variables to pass to a container.
|
Boolean |
getEssential()
If the
essential parameter of a container is marked as true , and that container fails
or stops for any reason, all other containers that are part of the task are stopped. |
List<HostEntry> |
getExtraHosts()
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
FirelensConfiguration |
getFirelensConfiguration()
The FireLens configuration for the container.
|
HealthCheck |
getHealthCheck()
The container health check command and associated configuration parameters for the container.
|
String |
getHostname()
The hostname to use for your container.
|
String |
getImage()
The image used to start a container.
|
Boolean |
getInteractive()
When this parameter is
true , you can deploy containerized applications that require
stdin or a tty to be allocated. |
List<String> |
getLinks()
The
links parameter allows containers to communicate with each other without the need for port
mappings. |
LinuxParameters |
getLinuxParameters()
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
|
LogConfiguration |
getLogConfiguration()
The log configuration specification for the container.
|
Integer |
getMemory()
The amount (in MiB) of memory to present to the container.
|
Integer |
getMemoryReservation()
The soft limit (in MiB) of memory to reserve for the container.
|
List<MountPoint> |
getMountPoints()
The mount points for data volumes in your container.
|
String |
getName()
The name of a container.
|
List<PortMapping> |
getPortMappings()
The list of port mappings for the container.
|
Boolean |
getPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
Boolean |
getPseudoTerminal()
When this parameter is
true , a TTY is allocated. |
Boolean |
getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
|
RepositoryCredentials |
getRepositoryCredentials()
The private repository authentication credentials to use.
|
List<ResourceRequirement> |
getResourceRequirements()
The type and amount of a resource to assign to a container.
|
List<Secret> |
getSecrets()
The secrets to pass to the container.
|
Integer |
getStartTimeout()
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
|
Integer |
getStopTimeout()
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its
own.
|
List<SystemControl> |
getSystemControls()
A list of namespaced kernel parameters to set in the container.
|
List<Ulimit> |
getUlimits()
A list of
ulimits to set in the container. |
String |
getUser()
The user to use inside the container.
|
List<VolumeFrom> |
getVolumesFrom()
Data volumes to mount from another container.
|
String |
getWorkingDirectory()
The working directory to run commands inside the container in.
|
int |
hashCode() |
Boolean |
isDisableNetworking()
When this parameter is true, networking is off within the container.
|
Boolean |
isEssential()
If the
essential parameter of a container is marked as true , and that container fails
or stops for any reason, all other containers that are part of the task are stopped. |
Boolean |
isInteractive()
When this parameter is
true , you can deploy containerized applications that require
stdin or a tty to be allocated. |
Boolean |
isPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
Boolean |
isPseudoTerminal()
When this parameter is
true , a TTY is allocated. |
Boolean |
isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCommand(Collection<String> command)
The command that's passed to the container.
|
void |
setCpu(Integer cpu)
The number of
cpu units reserved for the container. |
void |
setCredentialSpecs(Collection<String> credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec ) file that configures the
container for Active Directory authentication. |
void |
setDependsOn(Collection<ContainerDependency> dependsOn)
The dependencies defined for container startup and shutdown.
|
void |
setDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is off within the container.
|
void |
setDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
void |
setDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container.
|
void |
setDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container.
|
void |
setDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems.
|
void |
setEntryPoint(Collection<String> entryPoint)
|
void |
setEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
void |
setEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
A list of files containing the environment variables to pass to a container.
|
void |
setEssential(Boolean essential)
If the
essential parameter of a container is marked as true , and that container fails
or stops for any reason, all other containers that are part of the task are stopped. |
void |
setExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
void |
setFirelensConfiguration(FirelensConfiguration firelensConfiguration)
The FireLens configuration for the container.
|
void |
setHealthCheck(HealthCheck healthCheck)
The container health check command and associated configuration parameters for the container.
|
void |
setHostname(String hostname)
The hostname to use for your container.
|
void |
setImage(String image)
The image used to start a container.
|
void |
setInteractive(Boolean interactive)
When this parameter is
true , you can deploy containerized applications that require
stdin or a tty to be allocated. |
void |
setLinks(Collection<String> links)
The
links parameter allows containers to communicate with each other without the need for port
mappings. |
void |
setLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
|
void |
setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
void |
setMemory(Integer memory)
The amount (in MiB) of memory to present to the container.
|
void |
setMemoryReservation(Integer memoryReservation)
The soft limit (in MiB) of memory to reserve for the container.
|
void |
setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
void |
setName(String name)
The name of a container.
|
void |
setPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container.
|
void |
setPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
void |
setPseudoTerminal(Boolean pseudoTerminal)
When this parameter is
true , a TTY is allocated. |
void |
setReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
|
void |
setRepositoryCredentials(RepositoryCredentials repositoryCredentials)
The private repository authentication credentials to use.
|
void |
setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
void |
setSecrets(Collection<Secret> secrets)
The secrets to pass to the container.
|
void |
setStartTimeout(Integer startTimeout)
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
|
void |
setStopTimeout(Integer stopTimeout)
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its
own.
|
void |
setSystemControls(Collection<SystemControl> systemControls)
A list of namespaced kernel parameters to set in the container.
|
void |
setUlimits(Collection<Ulimit> ulimits)
A list of
ulimits to set in the container. |
void |
setUser(String user)
The user to use inside the container.
|
void |
setVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container.
|
void |
setWorkingDirectory(String workingDirectory)
The working directory to run commands inside the container in.
|
String |
toString()
Returns a string representation of this object.
|
ContainerDefinition |
withCommand(Collection<String> command)
The command that's passed to the container.
|
ContainerDefinition |
withCommand(String... command)
The command that's passed to the container.
|
ContainerDefinition |
withCpu(Integer cpu)
The number of
cpu units reserved for the container. |
ContainerDefinition |
withCredentialSpecs(Collection<String> credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec ) file that configures the
container for Active Directory authentication. |
ContainerDefinition |
withCredentialSpecs(String... credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec ) file that configures the
container for Active Directory authentication. |
ContainerDefinition |
withDependsOn(Collection<ContainerDependency> dependsOn)
The dependencies defined for container startup and shutdown.
|
ContainerDefinition |
withDependsOn(ContainerDependency... dependsOn)
The dependencies defined for container startup and shutdown.
|
ContainerDefinition |
withDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is off within the container.
|
ContainerDefinition |
withDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
ContainerDefinition |
withDnsSearchDomains(String... dnsSearchDomains)
A list of DNS search domains that are presented to the container.
|
ContainerDefinition |
withDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container.
|
ContainerDefinition |
withDnsServers(String... dnsServers)
A list of DNS servers that are presented to the container.
|
ContainerDefinition |
withDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container.
|
ContainerDefinition |
withDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems.
|
ContainerDefinition |
withDockerSecurityOptions(String... dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems.
|
ContainerDefinition |
withEntryPoint(Collection<String> entryPoint)
|
ContainerDefinition |
withEntryPoint(String... entryPoint)
|
ContainerDefinition |
withEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container.
|
ContainerDefinition |
withEnvironment(KeyValuePair... environment)
The environment variables to pass to a container.
|
ContainerDefinition |
withEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
A list of files containing the environment variables to pass to a container.
|
ContainerDefinition |
withEnvironmentFiles(EnvironmentFile... environmentFiles)
A list of files containing the environment variables to pass to a container.
|
ContainerDefinition |
withEssential(Boolean essential)
If the
essential parameter of a container is marked as true , and that container fails
or stops for any reason, all other containers that are part of the task are stopped. |
ContainerDefinition |
withExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
ContainerDefinition |
withExtraHosts(HostEntry... extraHosts)
A list of hostnames and IP address mappings to append to the
/etc/hosts file on the container. |
ContainerDefinition |
withFirelensConfiguration(FirelensConfiguration firelensConfiguration)
The FireLens configuration for the container.
|
ContainerDefinition |
withHealthCheck(HealthCheck healthCheck)
The container health check command and associated configuration parameters for the container.
|
ContainerDefinition |
withHostname(String hostname)
The hostname to use for your container.
|
ContainerDefinition |
withImage(String image)
The image used to start a container.
|
ContainerDefinition |
withInteractive(Boolean interactive)
When this parameter is
true , you can deploy containerized applications that require
stdin or a tty to be allocated. |
ContainerDefinition |
withLinks(Collection<String> links)
The
links parameter allows containers to communicate with each other without the need for port
mappings. |
ContainerDefinition |
withLinks(String... links)
The
links parameter allows containers to communicate with each other without the need for port
mappings. |
ContainerDefinition |
withLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
|
ContainerDefinition |
withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
|
ContainerDefinition |
withMemory(Integer memory)
The amount (in MiB) of memory to present to the container.
|
ContainerDefinition |
withMemoryReservation(Integer memoryReservation)
The soft limit (in MiB) of memory to reserve for the container.
|
ContainerDefinition |
withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
|
ContainerDefinition |
withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
|
ContainerDefinition |
withName(String name)
The name of a container.
|
ContainerDefinition |
withPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container.
|
ContainerDefinition |
withPortMappings(PortMapping... portMappings)
The list of port mappings for the container.
|
ContainerDefinition |
withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the
root user). |
ContainerDefinition |
withPseudoTerminal(Boolean pseudoTerminal)
When this parameter is
true , a TTY is allocated. |
ContainerDefinition |
withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system.
|
ContainerDefinition |
withRepositoryCredentials(RepositoryCredentials repositoryCredentials)
The private repository authentication credentials to use.
|
ContainerDefinition |
withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDefinition |
withResourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container.
|
ContainerDefinition |
withSecrets(Collection<Secret> secrets)
The secrets to pass to the container.
|
ContainerDefinition |
withSecrets(Secret... secrets)
The secrets to pass to the container.
|
ContainerDefinition |
withStartTimeout(Integer startTimeout)
Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
|
ContainerDefinition |
withStopTimeout(Integer stopTimeout)
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its
own.
|
ContainerDefinition |
withSystemControls(Collection<SystemControl> systemControls)
A list of namespaced kernel parameters to set in the container.
|
ContainerDefinition |
withSystemControls(SystemControl... systemControls)
A list of namespaced kernel parameters to set in the container.
|
ContainerDefinition |
withUlimits(Collection<Ulimit> ulimits)
A list of
ulimits to set in the container. |
ContainerDefinition |
withUlimits(Ulimit... ulimits)
A list of
ulimits to set in the container. |
ContainerDefinition |
withUser(String user)
The user to use inside the container.
|
ContainerDefinition |
withVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container.
|
ContainerDefinition |
withVolumesFrom(VolumeFrom... volumesFrom)
Data volumes to mount from another container.
|
ContainerDefinition |
withWorkingDirectory(String workingDirectory)
The working directory to run commands inside the container in.
|
public void setName(String name)
The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in the links
of another container to connect the
containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This
parameter maps to name
in the Create a container section of the
Docker Remote API and the --name
option to
docker run.
name
- The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in the links
of another container to
connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. This parameter maps to name
in the Create a container section
of the Docker Remote API and the
--name
option to docker run.public String getName()
The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in the links
of another container to connect the
containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This
parameter maps to name
in the Create a container section of the
Docker Remote API and the --name
option to
docker run.
name
of one container can be entered in the links
of another container to
connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens
are allowed. This parameter maps to name
in the Create a container section
of the Docker Remote API and the
--name
option to docker run.public ContainerDefinition withName(String name)
The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in the links
of another container to connect the
containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This
parameter maps to name
in the Create a container section of the
Docker Remote API and the --name
option to
docker run.
name
- The name of a container. If you're linking multiple containers together in a task definition, the
name
of one container can be entered in the links
of another container to
connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. This parameter maps to name
in the Create a container section
of the Docker Remote API and the
--name
option to docker run.public void setImage(String image)
The image used to start a container. This string is passed directly to the Docker daemon. By default, images in
the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the
Docker Remote API and the IMAGE
parameter of
docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
image
- The image used to start a container. This string is passed directly to the Docker daemon. By default,
images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and
lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed.
This parameter maps to Image
in the Create a container section
of the Docker Remote API and the
IMAGE
parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
public String getImage()
The image used to start a container. This string is passed directly to the Docker daemon. By default, images in
the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the
Docker Remote API and the IMAGE
parameter of
docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and
lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are
allowed. This parameter maps to Image
in the Create a container section
of the Docker Remote API and the
IMAGE
parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
public ContainerDefinition withImage(String image)
The image used to start a container. This string is passed directly to the Docker daemon. By default, images in
the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter
maps to Image
in the Create a container section of the
Docker Remote API and the IMAGE
parameter of
docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
image
- The image used to start a container. This string is passed directly to the Docker daemon. By default,
images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tag
or
repository-url/image@digest
. Up to 255 letters (uppercase and
lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed.
This parameter maps to Image
in the Create a container section
of the Docker Remote API and the
IMAGE
parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
or registry/repository@digest
. For example,
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or
012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or
mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
public void setRepositoryCredentials(RepositoryCredentials repositoryCredentials)
The private repository authentication credentials to use.
repositoryCredentials
- The private repository authentication credentials to use.public RepositoryCredentials getRepositoryCredentials()
The private repository authentication credentials to use.
public ContainerDefinition withRepositoryCredentials(RepositoryCredentials repositoryCredentials)
The private repository authentication credentials to use.
repositoryCredentials
- The private repository authentication credentials to use.public void setCpu(Integer cpu)
The number of cpu
units reserved for the container. This parameter maps to CpuShares
in
the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount
of CPU reserved for all containers within a task be lower than the task-level cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers
only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value
is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
cpu
- The number of cpu
units reserved for the container. This parameter maps to
CpuShares
in the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total
amount of CPU reserved for all containers within a task be lower than the task-level cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows
containers only have access to the specified amount of CPU that's described in the task definition. A null
or zero CPU value is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
public Integer getCpu()
The number of cpu
units reserved for the container. This parameter maps to CpuShares
in
the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount
of CPU reserved for all containers within a task be lower than the task-level cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers
only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value
is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
cpu
units reserved for the container. This parameter maps to
CpuShares
in the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the
total amount of CPU reserved for all containers within a task be lower than the task-level
cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows
containers only have access to the specified amount of CPU that's described in the task definition. A
null or zero CPU value is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
public ContainerDefinition withCpu(Integer cpu)
The number of cpu
units reserved for the container. This parameter maps to CpuShares
in
the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount
of CPU reserved for all containers within a task be lower than the task-level cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers
only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value
is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
cpu
- The number of cpu
units reserved for the container. This parameter maps to
CpuShares
in the Create a container section
of the Docker Remote API and the
--cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total
amount of CPU reserved for all containers within a task be lower than the task-level cpu
value.
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.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. 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's 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 is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, 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 isn't 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 two 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.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows
containers only have access to the specified amount of CPU that's described in the task definition. A null
or zero CPU value is passed to Docker as 0
, which Windows interprets as 1% of one CPU.
public void setMemory(Integer memory)
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. The total amount of memory reserved for all containers within a task
must be lower than the task memory
value, if one is specified. This parameter maps to
Memory
in the Create a
container section of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory
value. If you specify both a container-level memory
and memoryReservation
value,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memory
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory
value, if one is specified. This parameter maps to
Memory
in the Create a container section
of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level
memory value. If you specify both a container-level memory
and memoryReservation
value, memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public Integer getMemory()
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. The total amount of memory reserved for all containers within a task
must be lower than the task memory
value, if one is specified. This parameter maps to
Memory
in the Create a
container section of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory
value. If you specify both a container-level memory
and memoryReservation
value,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memory
value, if one is specified. This parameter
maps to Memory
in the Create a container section
of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level
memory value. If you specify both a container-level memory
and
memoryReservation
value, memory
must be greater than
memoryReservation
. If you specify memoryReservation
, then that value is
subtracted from the available memory resources for the container instance where the container is placed.
Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public ContainerDefinition withMemory(Integer memory)
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. The total amount of memory reserved for all containers within a task
must be lower than the task memory
value, if one is specified. This parameter maps to
Memory
in the Create a
container section of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory
value. If you specify both a container-level memory
and memoryReservation
value,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memory
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. The total amount of memory reserved for all containers within a
task must be lower than the task memory
value, if one is specified. This parameter maps to
Memory
in the Create a container section
of the Docker Remote API and the
--memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level
memory value. If you specify both a container-level memory
and memoryReservation
value, memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public void setMemoryReservation(Integer memoryReservation)
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention,
Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory
when it needs to, up to either the hard limit specified with the memory
parameter (if applicable),
or all of the available memory on the container instance, whichever comes first. This parameter maps to
MemoryReservation
in the Create a container section of the
Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for
short periods of time, you can set a memoryReservation
of 128 MiB, and a memory
hard
limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the
remaining resources on the container instance, but also allow the container to consume more memory resources when
needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memoryReservation
- The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy
contention, Docker attempts to keep the container memory to this soft limit. However, your container can
consume more memory when it needs to, up to either the hard limit specified with the memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes
first. This parameter maps to MemoryReservation
in the Create a container section
of the Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of
memory for short periods of time, you can set a memoryReservation
of 128 MiB, and a
memory
hard limit of 300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container instance, but also allow the container to
consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public Integer getMemoryReservation()
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention,
Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory
when it needs to, up to either the hard limit specified with the memory
parameter (if applicable),
or all of the available memory on the container instance, whichever comes first. This parameter maps to
MemoryReservation
in the Create a container section of the
Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for
short periods of time, you can set a memoryReservation
of 128 MiB, and a memory
hard
limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the
remaining resources on the container instance, but also allow the container to consume more memory resources when
needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes
first. This parameter maps to MemoryReservation
in the Create a container section
of the Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of
memory for short periods of time, you can set a memoryReservation
of 128 MiB, and a
memory
hard limit of 300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container instance, but also allow the container to
consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public ContainerDefinition withMemoryReservation(Integer memoryReservation)
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention,
Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory
when it needs to, up to either the hard limit specified with the memory
parameter (if applicable),
or all of the available memory on the container instance, whichever comes first. This parameter maps to
MemoryReservation
in the Create a container section of the
Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for
short periods of time, you can set a memoryReservation
of 128 MiB, and a memory
hard
limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the
remaining resources on the container instance, but also allow the container to consume more memory resources when
needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
memoryReservation
- The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy
contention, Docker attempts to keep the container memory to this soft limit. However, your container can
consume more memory when it needs to, up to either the hard limit specified with the memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes
first. This parameter maps to MemoryReservation
in the Create a container section
of the Docker Remote API and the
--memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
or memoryReservation
in a container definition. If you specify both,
memory
must be greater than memoryReservation
. If you specify
memoryReservation
, then that value is subtracted from the available memory resources for the
container instance where the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of
memory for short periods of time, you can set a memoryReservation
of 128 MiB, and a
memory
hard limit of 300 MiB. This configuration would allow the container to only reserve
128 MiB of memory from the remaining resources on the container instance, but also allow the container to
consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
public List<String> getLinks()
The links
parameter allows containers to communicate with each other without the need for port
mappings. This parameter is only supported if the network mode of a task definition is bridge
. The
name:internalName
construct is analogous to name:alias
in Docker links. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about
linking Docker containers, go to Legacy container links in
the Docker documentation. This parameter maps to Links
in the Create a container section of the
Docker Remote API and the --link
option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
links
parameter allows containers to communicate with each other without the need for
port mappings. This parameter is only supported if the network mode of a task definition is
bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation.
This parameter maps to Links
in the Create a container section
of the Docker Remote API and the
--link
option to docker run. This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
public void setLinks(Collection<String> links)
The links
parameter allows containers to communicate with each other without the need for port
mappings. This parameter is only supported if the network mode of a task definition is bridge
. The
name:internalName
construct is analogous to name:alias
in Docker links. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about
linking Docker containers, go to Legacy container links in
the Docker documentation. This parameter maps to Links
in the Create a container section of the
Docker Remote API and the --link
option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
links
- The links
parameter allows containers to communicate with each other without the need for
port mappings. This parameter is only supported if the network mode of a task definition is
bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This
parameter maps to Links
in the Create a container section
of the Docker Remote API and the
--link
option to docker run. This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
public ContainerDefinition withLinks(String... links)
The links
parameter allows containers to communicate with each other without the need for port
mappings. This parameter is only supported if the network mode of a task definition is bridge
. The
name:internalName
construct is analogous to name:alias
in Docker links. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about
linking Docker containers, go to Legacy container links in
the Docker documentation. This parameter maps to Links
in the Create a container section of the
Docker Remote API and the --link
option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
NOTE: This method appends the values to the existing list (if any). Use
setLinks(java.util.Collection)
or withLinks(java.util.Collection)
if you want to override the
existing values.
links
- The links
parameter allows containers to communicate with each other without the need for
port mappings. This parameter is only supported if the network mode of a task definition is
bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This
parameter maps to Links
in the Create a container section
of the Docker Remote API and the
--link
option to docker run. This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
public ContainerDefinition withLinks(Collection<String> links)
The links
parameter allows containers to communicate with each other without the need for port
mappings. This parameter is only supported if the network mode of a task definition is bridge
. The
name:internalName
construct is analogous to name:alias
in Docker links. Up to 255
letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about
linking Docker containers, go to Legacy container links in
the Docker documentation. This parameter maps to Links
in the Create a container section of the
Docker Remote API and the --link
option to
docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
links
- The links
parameter allows containers to communicate with each other without the need for
port mappings. This parameter is only supported if the network mode of a task definition is
bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This
parameter maps to Links
in the Create a container section
of the Docker Remote API and the
--link
option to docker run. This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
public List<PortMapping> getPortMappings()
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
.
The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's
no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the
Docker Remote API and the --publish
option
to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the network mode
of a task definition is set to host
, then host ports must either be undefined or they must match the
container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments
are visible in the Network Bindings section of a container description for a selected task in the Amazon
ECS console. The assignments are also visible in the networkBindings
section DescribeTasks
responses.
For task definitions that use the awsvpc
network mode, only specify the
containerPort
. The hostPort
can be left blank or it must be the same value as
the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
.
There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the
host itself.
This parameter maps to PortBindings
in the Create a container section
of the Docker Remote API and the
--publish
option to docker run. If the
network mode of a task definition is set to none
, then you can't specify port mappings. If
the network mode of a task definition is set to host
, then host ports must either be
undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port
assignments are visible in the Network Bindings section of a container description for a selected
task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
public void setPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
.
The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's
no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the
Docker Remote API and the --publish
option
to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the network mode
of a task definition is set to host
, then host ports must either be undefined or they must match the
container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments
are visible in the Network Bindings section of a container description for a selected task in the Amazon
ECS console. The assignments are also visible in the networkBindings
section DescribeTasks
responses.
portMappings
- The list of port mappings for the container. Port mappings allow containers to access ports on the host
container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the
containerPort
. The hostPort
can be left blank or it must be the same value as
the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
.
There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the
host itself.
This parameter maps to PortBindings
in the Create a container section
of the Docker Remote API and the
--publish
option to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the
network mode of a task definition is set to host
, then host ports must either be undefined or
they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port
assignments are visible in the Network Bindings section of a container description for a selected
task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
public ContainerDefinition withPortMappings(PortMapping... portMappings)
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
.
The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's
no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the
Docker Remote API and the --publish
option
to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the network mode
of a task definition is set to host
, then host ports must either be undefined or they must match the
container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments
are visible in the Network Bindings section of a container description for a selected task in the Amazon
ECS console. The assignments are also visible in the networkBindings
section DescribeTasks
responses.
NOTE: This method appends the values to the existing list (if any). Use
setPortMappings(java.util.Collection)
or withPortMappings(java.util.Collection)
if you want to
override the existing values.
portMappings
- The list of port mappings for the container. Port mappings allow containers to access ports on the host
container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the
containerPort
. The hostPort
can be left blank or it must be the same value as
the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
.
There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the
host itself.
This parameter maps to PortBindings
in the Create a container section
of the Docker Remote API and the
--publish
option to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the
network mode of a task definition is set to host
, then host ports must either be undefined or
they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port
assignments are visible in the Network Bindings section of a container description for a selected
task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
public ContainerDefinition withPortMappings(Collection<PortMapping> portMappings)
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the containerPort
.
The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There's
no loopback for port mappings on Windows, so you can't access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the
Docker Remote API and the --publish
option
to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the network mode
of a task definition is set to host
, then host ports must either be undefined or they must match the
container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments
are visible in the Network Bindings section of a container description for a selected task in the Amazon
ECS console. The assignments are also visible in the networkBindings
section DescribeTasks
responses.
portMappings
- The list of port mappings for the container. Port mappings allow containers to access ports on the host
container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, only specify the
containerPort
. The hostPort
can be left blank or it must be the same value as
the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
.
There's no loopback for port mappings on Windows, so you can't access a container's mapped port from the
host itself.
This parameter maps to PortBindings
in the Create a container section
of the Docker Remote API and the
--publish
option to docker run. If the network
mode of a task definition is set to none
, then you can't specify port mappings. If the
network mode of a task definition is set to host
, then host ports must either be undefined or
they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port
assignments are visible in the Network Bindings section of a container description for a selected
task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
public void setEssential(Boolean essential)
If the essential
parameter of a container is marked as true
, and that container fails
or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
essential
- If the essential
parameter of a container is marked as true
, and that container
fails or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't
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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
public Boolean getEssential()
If the essential
parameter of a container is marked as true
, and that container fails
or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
essential
parameter of a container is marked as true
, and that container
fails or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't
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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
public ContainerDefinition withEssential(Boolean essential)
If the essential
parameter of a container is marked as true
, and that container fails
or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
essential
- If the essential
parameter of a container is marked as true
, and that container
fails or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't
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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
public Boolean isEssential()
If the essential
parameter of a container is marked as true
, and that container fails
or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't 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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
essential
parameter of a container is marked as true
, and that container
fails or stops for any reason, all other containers that are part of the task are stopped. If the
essential
parameter of a container is marked as false
, its failure doesn't
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's composed of multiple containers, 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 Elastic Container Service Developer Guide.
public List<String> getEntryPoint()
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters. If you
have problems using entryPoint
, update your container agent or enter your commands and arguments as
command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section of the
Docker Remote API and the --entrypoint
option to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#entrypoint.
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters. If you have problems using entryPoint
, update your container agent or enter your
commands and arguments as command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section
of the Docker Remote API and the
--entrypoint
option to docker run. For more
information, see https://docs.docker
.com/engine/reference/builder/#entrypoint.
public void setEntryPoint(Collection<String> entryPoint)
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters. If you
have problems using entryPoint
, update your container agent or enter your commands and arguments as
command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section of the
Docker Remote API and the --entrypoint
option to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#entrypoint.
entryPoint
-
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters.
If you have problems using entryPoint
, update your container agent or enter your commands and
arguments as command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section
of the Docker Remote API and the
--entrypoint
option to docker run. For more
information, see https://docs.docker
.com/engine/reference/builder/#entrypoint.
public ContainerDefinition withEntryPoint(String... entryPoint)
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters. If you
have problems using entryPoint
, update your container agent or enter your commands and arguments as
command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section of the
Docker Remote API and the --entrypoint
option to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#entrypoint.
NOTE: This method appends the values to the existing list (if any). Use
setEntryPoint(java.util.Collection)
or withEntryPoint(java.util.Collection)
if you want to
override the existing values.
entryPoint
-
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters.
If you have problems using entryPoint
, update your container agent or enter your commands and
arguments as command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section
of the Docker Remote API and the
--entrypoint
option to docker run. For more
information, see https://docs.docker
.com/engine/reference/builder/#entrypoint.
public ContainerDefinition withEntryPoint(Collection<String> entryPoint)
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters. If you
have problems using entryPoint
, update your container agent or enter your commands and arguments as
command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section of the
Docker Remote API and the --entrypoint
option to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#entrypoint.
entryPoint
-
Early versions of the Amazon ECS container agent don't properly handle entryPoint
parameters.
If you have problems using entryPoint
, update your container agent or enter your commands and
arguments as command
array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint
in the Create a container section
of the Docker Remote API and the
--entrypoint
option to docker run. For more
information, see https://docs.docker
.com/engine/reference/builder/#entrypoint.
public List<String> getCommand()
The command that's passed to the container. This parameter maps to Cmd
in the Create a container section of the
Docker Remote API and the COMMAND
parameter
to docker run. For more
information, see https://docs.docker.com/engine/reference
/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.
Cmd
in the Create a container section
of the Docker Remote API and the
COMMAND
parameter to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the
array.public void setCommand(Collection<String> command)
The command that's passed to the container. This parameter maps to Cmd
in the Create a container section of the
Docker Remote API and the COMMAND
parameter
to docker run. For more
information, see https://docs.docker.com/engine/reference
/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.
command
- The command that's passed to the container. This parameter maps to Cmd
in the Create a container section
of the Docker Remote API and the
COMMAND
parameter to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the
array.public ContainerDefinition withCommand(String... command)
The command that's passed to the container. This parameter maps to Cmd
in the Create a container section of the
Docker Remote API and the COMMAND
parameter
to docker run. For more
information, see https://docs.docker.com/engine/reference
/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.
NOTE: This method appends the values to the existing list (if any). Use
setCommand(java.util.Collection)
or withCommand(java.util.Collection)
if you want to override
the existing values.
command
- The command that's passed to the container. This parameter maps to Cmd
in the Create a container section
of the Docker Remote API and the
COMMAND
parameter to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the
array.public ContainerDefinition withCommand(Collection<String> command)
The command that's passed to the container. This parameter maps to Cmd
in the Create a container section of the
Docker Remote API and the COMMAND
parameter
to docker run. For more
information, see https://docs.docker.com/engine/reference
/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.
command
- The command that's passed to the container. This parameter maps to Cmd
in the Create a container section
of the Docker Remote API and the
COMMAND
parameter to docker run. For more
information, see https://docs.docker.com/engine
/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the
array.public List<KeyValuePair> getEnvironment()
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the
Docker Remote API and the --env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
Env
in the Create a container section
of the Docker Remote API and the
--env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
public void setEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the
Docker Remote API and the --env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
environment
- The environment variables to pass to a container. This parameter maps to Env
in the Create a container section
of the Docker Remote API and the
--env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
public ContainerDefinition withEnvironment(KeyValuePair... environment)
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the
Docker Remote API and the --env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironment(java.util.Collection)
or withEnvironment(java.util.Collection)
if you want to
override the existing values.
environment
- The environment variables to pass to a container. This parameter maps to Env
in the Create a container section
of the Docker Remote API and the
--env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
public ContainerDefinition withEnvironment(Collection<KeyValuePair> environment)
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the
Docker Remote API and the --env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
environment
- The environment variables to pass to a container. This parameter maps to Env
in the Create a container section
of the Docker Remote API and the
--env
option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
public List<EnvironmentFile> getEnvironmentFiles()
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in
an environment file contains an environment variable in VARIABLE=VALUE
format. Lines beginning with
#
are treated as comments and are ignored. For more information about the environment variable file
syntax, see Declare default environment variables in
file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed from the top down. We recommend that you
use unique variable names. For more information, see Specifying Environment
Variables in the Amazon Elastic Container Service Developer Guide.
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each
line in an environment file contains an environment variable in VARIABLE=VALUE
format. Lines
beginning with #
are treated as comments and are ignored. For more information about the
environment variable file syntax, see Declare default
environment variables in file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple
environment files are specified that contain the same variable, they're processed from the top down. We
recommend that you use unique variable names. For more information, see Specifying
Environment Variables in the Amazon Elastic Container Service Developer Guide.
public void setEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in
an environment file contains an environment variable in VARIABLE=VALUE
format. Lines beginning with
#
are treated as comments and are ignored. For more information about the environment variable file
syntax, see Declare default environment variables in
file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed from the top down. We recommend that you
use unique variable names. For more information, see Specifying Environment
Variables in the Amazon Elastic Container Service Developer Guide.
environmentFiles
- A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each
line in an environment file contains an environment variable in VARIABLE=VALUE
format. Lines
beginning with #
are treated as comments and are ignored. For more information about the
environment variable file syntax, see Declare default
environment variables in file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple
environment files are specified that contain the same variable, they're processed from the top down. We
recommend that you use unique variable names. For more information, see Specifying
Environment Variables in the Amazon Elastic Container Service Developer Guide.
public ContainerDefinition withEnvironmentFiles(EnvironmentFile... environmentFiles)
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in
an environment file contains an environment variable in VARIABLE=VALUE
format. Lines beginning with
#
are treated as comments and are ignored. For more information about the environment variable file
syntax, see Declare default environment variables in
file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed from the top down. We recommend that you
use unique variable names. For more information, see Specifying Environment
Variables in the Amazon Elastic Container Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentFiles(java.util.Collection)
or withEnvironmentFiles(java.util.Collection)
if you
want to override the existing values.
environmentFiles
- A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each
line in an environment file contains an environment variable in VARIABLE=VALUE
format. Lines
beginning with #
are treated as comments and are ignored. For more information about the
environment variable file syntax, see Declare default
environment variables in file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple
environment files are specified that contain the same variable, they're processed from the top down. We
recommend that you use unique variable names. For more information, see Specifying
Environment Variables in the Amazon Elastic Container Service Developer Guide.
public ContainerDefinition withEnvironmentFiles(Collection<EnvironmentFile> environmentFiles)
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each line in
an environment file contains an environment variable in VARIABLE=VALUE
format. Lines beginning with
#
are treated as comments and are ignored. For more information about the environment variable file
syntax, see Declare default environment variables in
file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed from the top down. We recommend that you
use unique variable names. For more information, see Specifying Environment
Variables in the Amazon Elastic Container Service Developer Guide.
environmentFiles
- A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
file extension. Each
line in an environment file contains an environment variable in VARIABLE=VALUE
format. Lines
beginning with #
are treated as comments and are ignored. For more information about the
environment variable file syntax, see Declare default
environment variables in file.
If there are environment variables specified using the environment
parameter in a container
definition, they take precedence over the variables contained within an environment file. If multiple
environment files are specified that contain the same variable, they're processed from the top down. We
recommend that you use unique variable names. For more information, see Specifying
Environment Variables in the Amazon Elastic Container Service Developer Guide.
public List<MountPoint> getMountPoints()
The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the
Docker Remote API and the --volume
option to
docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
This parameter maps to Volumes
in the Create a container section
of the Docker Remote API and the
--volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
.
Windows containers can't mount directories on a different drive, and mount point can't be across drives.
public void setMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the
Docker Remote API and the --volume
option to
docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
mountPoints
- The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section
of the Docker Remote API and the
--volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
public ContainerDefinition withMountPoints(MountPoint... mountPoints)
The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the
Docker Remote API and the --volume
option to
docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
NOTE: This method appends the values to the existing list (if any). Use
setMountPoints(java.util.Collection)
or withMountPoints(java.util.Collection)
if you want to
override the existing values.
mountPoints
- The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section
of the Docker Remote API and the
--volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
public ContainerDefinition withMountPoints(Collection<MountPoint> mountPoints)
The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the
Docker Remote API and the --volume
option to
docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
mountPoints
- The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section
of the Docker Remote API and the
--volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows
containers can't mount directories on a different drive, and mount point can't be across drives.
public List<VolumeFrom> getVolumesFrom()
Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the
Docker Remote API and the --volumes-from
option to docker run.
VolumesFrom
in the Create a container section
of the Docker Remote API and the
--volumes-from
option to docker run.public void setVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the
Docker Remote API and the --volumes-from
option to docker run.
volumesFrom
- Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section
of the Docker Remote API and the
--volumes-from
option to docker run.public ContainerDefinition withVolumesFrom(VolumeFrom... volumesFrom)
Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the
Docker Remote API and the --volumes-from
option to docker run.
NOTE: This method appends the values to the existing list (if any). Use
setVolumesFrom(java.util.Collection)
or withVolumesFrom(java.util.Collection)
if you want to
override the existing values.
volumesFrom
- Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section
of the Docker Remote API and the
--volumes-from
option to docker run.public ContainerDefinition withVolumesFrom(Collection<VolumeFrom> volumesFrom)
Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the
Docker Remote API and the --volumes-from
option to docker run.
volumesFrom
- Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section
of the Docker Remote API and the
--volumes-from
option to docker run.public void setLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
linuxParameters
- Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For
more information see KernelCapabilities. This parameter is not supported for Windows containers.
public LinuxParameters getLinuxParameters()
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
This parameter is not supported for Windows containers.
public ContainerDefinition withLinuxParameters(LinuxParameters linuxParameters)
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
linuxParameters
- Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For
more information see KernelCapabilities. This parameter is not supported for Windows containers.
public List<Secret> getSecrets()
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
public void setSecrets(Collection<Secret> secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.public ContainerDefinition withSecrets(Secret... secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setSecrets(java.util.Collection)
or withSecrets(java.util.Collection)
if you want to override
the existing values.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.public ContainerDefinition withSecrets(Collection<Secret> secrets)
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.public List<ContainerDependency> getDependsOn()
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
agent to turn on container dependencies. However, we recommend using the latest container agent version. For
information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the
container agent to turn on container dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
public void setDependsOn(Collection<ContainerDependency> dependsOn)
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
agent to turn on container dependencies. However, we recommend using the latest container agent version. For
information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
dependsOn
- The dependencies defined for container startup and shutdown. A container can contain multiple dependencies
on other containers in a task definition. When a dependency is defined for container startup, for
container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the
container agent to turn on container dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
public ContainerDefinition withDependsOn(ContainerDependency... dependsOn)
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
agent to turn on container dependencies. However, we recommend using the latest container agent version. For
information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
NOTE: This method appends the values to the existing list (if any). Use
setDependsOn(java.util.Collection)
or withDependsOn(java.util.Collection)
if you want to
override the existing values.
dependsOn
- The dependencies defined for container startup and shutdown. A container can contain multiple dependencies
on other containers in a task definition. When a dependency is defined for container startup, for
container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the
container agent to turn on container dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
public ContainerDefinition withDependsOn(Collection<ContainerDependency> dependsOn)
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
agent to turn on container dependencies. However, we recommend using the latest container agent version. For
information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
dependsOn
- The dependencies defined for container startup and shutdown. A container can contain multiple dependencies
on other containers in a task definition. When a dependency is defined for container startup, for
container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the
container agent to turn on container dependencies. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
public void setStartTimeout(Integer startTimeout)
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you
specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
, SUCCESS
, or HEALTHY
status. If a startTimeout
value
is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and
not start. This results in the task transitioning to a STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced
independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0
of the
container agent to use a container start timeout value. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of the ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain
the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
startTimeout
- Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For
example, you specify two containers in a task definition with containerA having a dependency on containerB
reaching a COMPLETE
, SUCCESS
, or HEALTHY
status. If a
startTimeout
value is specified for containerB and it doesn't reach the desired status within
that time then containerA gives up and not start. This results in the task transitioning to a
STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's
enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0
of the container agent to use a container start timeout value. However, we recommend using the latest
container agent version. For information about checking your agent version and updating to the latest
version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public Integer getStartTimeout()
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you
specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
, SUCCESS
, or HEALTHY
status. If a startTimeout
value
is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and
not start. This results in the task transitioning to a STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced
independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0
of the
container agent to use a container start timeout value. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of the ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain
the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
COMPLETE
, SUCCESS
, or HEALTHY
status. If a
startTimeout
value is specified for containerB and it doesn't reach the desired status
within that time then containerA gives up and not start. This results in the task transitioning to a
STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's
enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version
1.26.0
of the container agent to use a container start timeout value. However, we recommend
using the latest container agent version. For information about checking your agent version and updating
to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of
the ecs-init
package. If your container instances are launched from version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public ContainerDefinition withStartTimeout(Integer startTimeout)
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you
specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
, SUCCESS
, or HEALTHY
status. If a startTimeout
value
is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and
not start. This results in the task transitioning to a STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's enforced
independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0
of the
container agent to use a container start timeout value. However, we recommend using the latest container agent
version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of the ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain
the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
startTimeout
- Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For
example, you specify two containers in a task definition with containerA having a dependency on containerB
reaching a COMPLETE
, SUCCESS
, or HEALTHY
status. If a
startTimeout
value is specified for containerB and it doesn't reach the desired status within
that time then containerA gives up and not start. This results in the task transitioning to a
STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it's
enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
For tasks using the EC2 launch type, your container instances require at least version 1.26.0
of the container agent to use a container start timeout value. However, we recommend using the latest
container agent version. For information about checking your agent version and updating to the latest
version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public void setStopTimeout(Integer stopTimeout)
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the value set
for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT
is used. If
neither the stopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
agent configuration
variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers
are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop
timeout value. However, we recommend using the latest container agent version. For information about checking
your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
stopTimeout
- Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally
on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the
value set for the Amazon ECS container agent configuration variable
ECS_CONTAINER_STOP_TIMEOUT
is used. If neither the stopTimeout
parameter or the
ECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of
30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances
require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we
recommend using the latest container agent version. For information about checking your agent version and
updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public Integer getStopTimeout()
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the value set
for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT
is used. If
neither the stopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
agent configuration
variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers
are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop
timeout value. However, we recommend using the latest container agent version. For information about checking
your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the
value set for the Amazon ECS container agent configuration variable
ECS_CONTAINER_STOP_TIMEOUT
is used. If neither the stopTimeout
parameter or the
ECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of
30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances
require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we
recommend using the latest container agent version. For information about checking your agent version and
updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version
20190301
or later, then they contain the required versions of the container agent and
ecs-init
. For more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public ContainerDefinition withStopTimeout(Integer stopTimeout)
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the value set
for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT
is used. If
neither the stopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
agent configuration
variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers
are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop
timeout value. However, we recommend using the latest container agent version. For information about checking
your agent version and updating to the latest version, see Updating the Amazon ECS
Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If
your container instances are launched from version 20190301
or later, then they contain the required
versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized
Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
stopTimeout
- Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally
on its own.
For tasks using the Fargate launch type, the task or service requires the following platforms:
Linux platform version 1.3.0
or later.
Windows platform version 1.0.0
or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks that use the EC2 launch type, if the stopTimeout
parameter isn't specified, the
value set for the Amazon ECS container agent configuration variable
ECS_CONTAINER_STOP_TIMEOUT
is used. If neither the stopTimeout
parameter or the
ECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of
30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances
require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we
recommend using the latest container agent version. For information about checking your agent version and
updating to the latest version, see Updating the
Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're
using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For
more information, see Amazon
ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
public void setHostname(String hostname)
The hostname to use for your container. This parameter maps to Hostname
in the Create a container section of the
Docker Remote API and the --hostname
option
to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network mode.
hostname
- The hostname to use for your container. This parameter maps to Hostname
in the Create a container section
of the Docker Remote API and the
--hostname
option to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network mode.
public String getHostname()
The hostname to use for your container. This parameter maps to Hostname
in the Create a container section of the
Docker Remote API and the --hostname
option
to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network mode.
Hostname
in the Create a container section
of the Docker Remote API and the
--hostname
option to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network
mode.
public ContainerDefinition withHostname(String hostname)
The hostname to use for your container. This parameter maps to Hostname
in the Create a container section of the
Docker Remote API and the --hostname
option
to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network mode.
hostname
- The hostname to use for your container. This parameter maps to Hostname
in the Create a container section
of the Docker Remote API and the
--hostname
option to docker run.
The hostname
parameter is not supported if you're using the awsvpc
network mode.
public void setUser(String user)
The user to use inside the container. This parameter maps to User
in the Create a container section of the
Docker Remote API and the --user
option to
docker run.
When running tasks using the host
network mode, don't run containers using the root user (UID 0). We
recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must specify
it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
user
- The user to use inside the container. This parameter maps to User
in the Create a container section
of the Docker Remote API and the
--user
option to docker run.
When running tasks using the host
network mode, don't run containers using the root user (UID
0). We recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must
specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
public String getUser()
The user to use inside the container. This parameter maps to User
in the Create a container section of the
Docker Remote API and the --user
option to
docker run.
When running tasks using the host
network mode, don't run containers using the root user (UID 0). We
recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must specify
it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
User
in the Create a container section
of the Docker Remote API and the
--user
option to docker run.
When running tasks using the host
network mode, don't run containers using the root user
(UID 0). We recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must
specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
public ContainerDefinition withUser(String user)
The user to use inside the container. This parameter maps to User
in the Create a container section of the
Docker Remote API and the --user
option to
docker run.
When running tasks using the host
network mode, don't run containers using the root user (UID 0). We
recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must specify
it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
user
- The user to use inside the container. This parameter maps to User
in the Create a container section
of the Docker Remote API and the
--user
option to docker run.
When running tasks using the host
network mode, don't run containers using the root user (UID
0). We recommend using a non-root user for better security.
You can specify the user
using the following formats. If specifying a UID or GID, you must
specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
public void setWorkingDirectory(String workingDirectory)
The working directory to run commands inside the container in. This parameter maps to WorkingDir
in
the Create a container section
of the Docker Remote API and the --workdir
option to docker run.
workingDirectory
- The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the Create a container section
of the Docker Remote API and the
--workdir
option to docker run.public String getWorkingDirectory()
The working directory to run commands inside the container in. This parameter maps to WorkingDir
in
the Create a container section
of the Docker Remote API and the --workdir
option to docker run.
WorkingDir
in the Create a container section
of the Docker Remote API and the
--workdir
option to docker run.public ContainerDefinition withWorkingDirectory(String workingDirectory)
The working directory to run commands inside the container in. This parameter maps to WorkingDir
in
the Create a container section
of the Docker Remote API and the --workdir
option to docker run.
workingDirectory
- The working directory to run commands inside the container in. This parameter maps to
WorkingDir
in the Create a container section
of the Docker Remote API and the
--workdir
option to docker run.public void setDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section of the
Docker Remote API.
This parameter is not supported for Windows containers.
disableNetworking
- When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section
of the Docker Remote API. This parameter is not supported for Windows containers.
public Boolean getDisableNetworking()
When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section of the
Docker Remote API.
This parameter is not supported for Windows containers.
NetworkDisabled
in the Create a container section
of the Docker Remote API. This parameter is not supported for Windows containers.
public ContainerDefinition withDisableNetworking(Boolean disableNetworking)
When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section of the
Docker Remote API.
This parameter is not supported for Windows containers.
disableNetworking
- When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section
of the Docker Remote API. This parameter is not supported for Windows containers.
public Boolean isDisableNetworking()
When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabled
in the Create a container section of the
Docker Remote API.
This parameter is not supported for Windows containers.
NetworkDisabled
in the Create a container section
of the Docker Remote API. This parameter is not supported for Windows containers.
public void setPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user). This parameter maps to Privileged
in the Create a container section of the
Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
privileged
- When this parameter is true, the container is given elevated privileges on the host container instance
(similar to the root
user). This parameter maps to Privileged
in the Create a container section
of the Docker Remote API and the
--privileged
option to docker run. This parameter is not supported for Windows containers or tasks run on Fargate.
public Boolean getPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user). This parameter maps to Privileged
in the Create a container section of the
Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
root
user). This parameter maps to Privileged
in the Create a container section
of the Docker Remote API and the
--privileged
option to docker run. This parameter is not supported for Windows containers or tasks run on Fargate.
public ContainerDefinition withPrivileged(Boolean privileged)
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user). This parameter maps to Privileged
in the Create a container section of the
Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
privileged
- When this parameter is true, the container is given elevated privileges on the host container instance
(similar to the root
user). This parameter maps to Privileged
in the Create a container section
of the Docker Remote API and the
--privileged
option to docker run. This parameter is not supported for Windows containers or tasks run on Fargate.
public Boolean isPrivileged()
When this parameter is true, the container is given elevated privileges on the host container instance (similar
to the root
user). This parameter maps to Privileged
in the Create a container section of the
Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks run on Fargate.
root
user). This parameter maps to Privileged
in the Create a container section
of the Docker Remote API and the
--privileged
option to docker run. This parameter is not supported for Windows containers or tasks run on Fargate.
public void setReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system. This parameter maps
to ReadonlyRootfs
in the Create a container section of the
Docker Remote API and the --read-only
option
to docker run.
This parameter is not supported for Windows containers.
readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to its root file system. This
parameter maps to ReadonlyRootfs
in the Create a container section
of the Docker Remote API and the
--read-only
option to docker run. This parameter is not supported for Windows containers.
public Boolean getReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system. This parameter maps
to ReadonlyRootfs
in the Create a container section of the
Docker Remote API and the --read-only
option
to docker run.
This parameter is not supported for Windows containers.
ReadonlyRootfs
in the Create a container section
of the Docker Remote API and the
--read-only
option to docker run. This parameter is not supported for Windows containers.
public ContainerDefinition withReadonlyRootFilesystem(Boolean readonlyRootFilesystem)
When this parameter is true, the container is given read-only access to its root file system. This parameter maps
to ReadonlyRootfs
in the Create a container section of the
Docker Remote API and the --read-only
option
to docker run.
This parameter is not supported for Windows containers.
readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to its root file system. This
parameter maps to ReadonlyRootfs
in the Create a container section
of the Docker Remote API and the
--read-only
option to docker run. This parameter is not supported for Windows containers.
public Boolean isReadonlyRootFilesystem()
When this parameter is true, the container is given read-only access to its root file system. This parameter maps
to ReadonlyRootfs
in the Create a container section of the
Docker Remote API and the --read-only
option
to docker run.
This parameter is not supported for Windows containers.
ReadonlyRootfs
in the Create a container section
of the Docker Remote API and the
--read-only
option to docker run. This parameter is not supported for Windows containers.
public List<String> getDnsServers()
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the
Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
Dns
in the
Create a container
section of the Docker Remote API and the
--dns
option to docker run. This parameter is not supported for Windows containers.
public void setDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the
Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
dnsServers
- A list of DNS servers that are presented to the container. This parameter maps to Dns
in the
Create a container
section of the Docker Remote API and the
--dns
option to docker run. This parameter is not supported for Windows containers.
public ContainerDefinition withDnsServers(String... dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the
Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
NOTE: This method appends the values to the existing list (if any). Use
setDnsServers(java.util.Collection)
or withDnsServers(java.util.Collection)
if you want to
override the existing values.
dnsServers
- A list of DNS servers that are presented to the container. This parameter maps to Dns
in the
Create a container
section of the Docker Remote API and the
--dns
option to docker run. This parameter is not supported for Windows containers.
public ContainerDefinition withDnsServers(Collection<String> dnsServers)
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the
Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
dnsServers
- A list of DNS servers that are presented to the container. This parameter maps to Dns
in the
Create a container
section of the Docker Remote API and the
--dns
option to docker run. This parameter is not supported for Windows containers.
public List<String> getDnsSearchDomains()
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container
section of the Docker Remote API and the
--dns-search
option to docker run.
This parameter is not supported for Windows containers.
DnsSearch
in the Create a container section
of the Docker Remote API and the
--dns-search
option to docker run. This parameter is not supported for Windows containers.
public void setDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container
section of the Docker Remote API and the
--dns-search
option to docker run.
This parameter is not supported for Windows containers.
dnsSearchDomains
- A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the Create a container section
of the Docker Remote API and the
--dns-search
option to docker run. This parameter is not supported for Windows containers.
public ContainerDefinition withDnsSearchDomains(String... dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container
section of the Docker Remote API and the
--dns-search
option to docker run.
This parameter is not supported for Windows containers.
NOTE: This method appends the values to the existing list (if any). Use
setDnsSearchDomains(java.util.Collection)
or withDnsSearchDomains(java.util.Collection)
if you
want to override the existing values.
dnsSearchDomains
- A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the Create a container section
of the Docker Remote API and the
--dns-search
option to docker run. This parameter is not supported for Windows containers.
public ContainerDefinition withDnsSearchDomains(Collection<String> dnsSearchDomains)
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container
section of the Docker Remote API and the
--dns-search
option to docker run.
This parameter is not supported for Windows containers.
dnsSearchDomains
- A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the Create a container section
of the Docker Remote API and the
--dns-search
option to docker run. This parameter is not supported for Windows containers.
public List<HostEntry> getExtraHosts()
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This
parameter maps to ExtraHosts
in the Create a container section of the
Docker Remote API and the --add-host
option
to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network mode.
/etc/hosts
file on the
container. This parameter maps to ExtraHosts
in the Create a container section
of the Docker Remote API and the
--add-host
option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network
mode.
public void setExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This
parameter maps to ExtraHosts
in the Create a container section of the
Docker Remote API and the --add-host
option
to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network mode.
extraHosts
- A list of hostnames and IP address mappings to append to the /etc/hosts
file on the
container. This parameter maps to ExtraHosts
in the Create a container section
of the Docker Remote API and the
--add-host
option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network
mode.
public ContainerDefinition withExtraHosts(HostEntry... extraHosts)
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This
parameter maps to ExtraHosts
in the Create a container section of the
Docker Remote API and the --add-host
option
to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network mode.
NOTE: This method appends the values to the existing list (if any). Use
setExtraHosts(java.util.Collection)
or withExtraHosts(java.util.Collection)
if you want to
override the existing values.
extraHosts
- A list of hostnames and IP address mappings to append to the /etc/hosts
file on the
container. This parameter maps to ExtraHosts
in the Create a container section
of the Docker Remote API and the
--add-host
option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network
mode.
public ContainerDefinition withExtraHosts(Collection<HostEntry> extraHosts)
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This
parameter maps to ExtraHosts
in the Create a container section of the
Docker Remote API and the --add-host
option
to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network mode.
extraHosts
- A list of hostnames and IP address mappings to append to the /etc/hosts
file on the
container. This parameter maps to ExtraHosts
in the Create a container section
of the Docker Remote API and the
--add-host
option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
network
mode.
public List<String> getDockerSecurityOptions()
A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section of the
Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section
of the Docker Remote API and the
--security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
public void setDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section of the
Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
dockerSecurityOptions
- A list of strings to provide custom configuration for multiple security systems. For more information
about valid values, see Docker Run Security
Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section
of the Docker Remote API and the
--security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
public ContainerDefinition withDockerSecurityOptions(String... dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section of the
Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
NOTE: This method appends the values to the existing list (if any). Use
setDockerSecurityOptions(java.util.Collection)
or
withDockerSecurityOptions(java.util.Collection)
if you want to override the existing values.
dockerSecurityOptions
- A list of strings to provide custom configuration for multiple security systems. For more information
about valid values, see Docker Run Security
Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section
of the Docker Remote API and the
--security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
public ContainerDefinition withDockerSecurityOptions(Collection<String> dockerSecurityOptions)
A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section of the
Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before
containers placed on that instance can use these security options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
dockerSecurityOptions
- A list of strings to provide custom configuration for multiple security systems. For more information
about valid values, see Docker Run Security
Configuration. This field isn't valid for containers in tasks using the Fargate launch type.
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt
in the Create a container section
of the Docker Remote API and the
--security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables
before containers placed on that instance can use these security options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
public void setInteractive(Boolean interactive)
When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the
Docker Remote API and the --interactive
option to docker run.
interactive
- When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in
the Create a container
section of the Docker Remote API and the
--interactive
option to docker run.public Boolean getInteractive()
When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the
Docker Remote API and the --interactive
option to docker run.
true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a
container section of the Docker Remote API
and the --interactive
option to docker run.public ContainerDefinition withInteractive(Boolean interactive)
When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the
Docker Remote API and the --interactive
option to docker run.
interactive
- When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in
the Create a container
section of the Docker Remote API and the
--interactive
option to docker run.public Boolean isInteractive()
When this parameter is true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the
Docker Remote API and the --interactive
option to docker run.
true
, you can deploy containerized applications that require
stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a
container section of the Docker Remote API
and the --interactive
option to docker run.public void setPseudoTerminal(Boolean pseudoTerminal)
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the
Docker Remote API and the --tty
option to docker run.
pseudoTerminal
- When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in
the Create a container
section of the Docker Remote API and the
--tty
option to docker run.public Boolean getPseudoTerminal()
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the
Docker Remote API and the --tty
option to docker run.
true
, a TTY is allocated. This parameter maps to Tty
in
the Create a container
section of the Docker Remote API and the
--tty
option to docker run.public ContainerDefinition withPseudoTerminal(Boolean pseudoTerminal)
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the
Docker Remote API and the --tty
option to docker run.
pseudoTerminal
- When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in
the Create a container
section of the Docker Remote API and the
--tty
option to docker run.public Boolean isPseudoTerminal()
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the
Docker Remote API and the --tty
option to docker run.
true
, a TTY is allocated. This parameter maps to Tty
in
the Create a container
section of the Docker Remote API and the
--tty
option to docker run.public Map<String,String> getDockerLabels()
A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section of the
Docker Remote API and the --label
option to
docker run. This parameter
requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote
API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Labels
in the Create a container section
of the Docker Remote API and the
--label
option to docker run. This
parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check
the Docker Remote API version on your container instance, log in to your container instance and run the
following command: sudo docker version --format '{{.Server.APIVersion}}'
public void setDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section of the
Docker Remote API and the --label
option to
docker run. This parameter
requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote
API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
dockerLabels
- A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section
of the Docker Remote API and the
--label
option to docker run. This parameter
requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker
Remote API version on your container instance, log in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
public ContainerDefinition withDockerLabels(Map<String,String> dockerLabels)
A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section of the
Docker Remote API and the --label
option to
docker run. This parameter
requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote
API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
dockerLabels
- A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section
of the Docker Remote API and the
--label
option to docker run. This parameter
requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker
Remote API version on your container instance, log in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
public ContainerDefinition addDockerLabelsEntry(String key, String value)
public ContainerDefinition clearDockerLabelsEntries()
public List<Ulimit> getUlimits()
A list of ulimits
to set in the container. If a ulimit
value is specified in a task
definition, it overrides the default values set by Docker. This parameter maps to Ulimits
in the Create a container section of the
Docker Remote API and the --ulimit
option to
docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the
exception of the nofile
resource limit parameter which Fargate overrides. The nofile
resource limit sets a restriction on the number of open files that a container can use. The default
nofile
soft limit is 1024
and the default hard limit is 65535
.
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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
ulimits
to set in the container. If a ulimit
value is specified in a
task definition, it overrides the default values set by Docker. This parameter maps to
Ulimits
in the Create a container section
of the Docker Remote API and the
--ulimit
option to docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with
the exception of the nofile
resource limit parameter which Fargate overrides. The
nofile
resource limit sets a restriction on the number of open files that a container can
use. The default nofile
soft limit is 1024
and the default hard limit is
65535
.
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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
public void setUlimits(Collection<Ulimit> ulimits)
A list of ulimits
to set in the container. If a ulimit
value is specified in a task
definition, it overrides the default values set by Docker. This parameter maps to Ulimits
in the Create a container section of the
Docker Remote API and the --ulimit
option to
docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the
exception of the nofile
resource limit parameter which Fargate overrides. The nofile
resource limit sets a restriction on the number of open files that a container can use. The default
nofile
soft limit is 1024
and the default hard limit is 65535
.
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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
ulimits
- A list of ulimits
to set in the container. If a ulimit
value is specified in a
task definition, it overrides the default values set by Docker. This parameter maps to
Ulimits
in the Create a container section
of the Docker Remote API and the
--ulimit
option to docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with
the exception of the nofile
resource limit parameter which Fargate overrides. The
nofile
resource limit sets a restriction on the number of open files that a container can
use. The default nofile
soft limit is 1024
and the default hard limit is
65535
.
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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
public ContainerDefinition withUlimits(Ulimit... ulimits)
A list of ulimits
to set in the container. If a ulimit
value is specified in a task
definition, it overrides the default values set by Docker. This parameter maps to Ulimits
in the Create a container section of the
Docker Remote API and the --ulimit
option to
docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the
exception of the nofile
resource limit parameter which Fargate overrides. The nofile
resource limit sets a restriction on the number of open files that a container can use. The default
nofile
soft limit is 1024
and the default hard limit is 65535
.
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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
NOTE: This method appends the values to the existing list (if any). Use
setUlimits(java.util.Collection)
or withUlimits(java.util.Collection)
if you want to override
the existing values.
ulimits
- A list of ulimits
to set in the container. If a ulimit
value is specified in a
task definition, it overrides the default values set by Docker. This parameter maps to
Ulimits
in the Create a container section
of the Docker Remote API and the
--ulimit
option to docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with
the exception of the nofile
resource limit parameter which Fargate overrides. The
nofile
resource limit sets a restriction on the number of open files that a container can
use. The default nofile
soft limit is 1024
and the default hard limit is
65535
.
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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
public ContainerDefinition withUlimits(Collection<Ulimit> ulimits)
A list of ulimits
to set in the container. If a ulimit
value is specified in a task
definition, it overrides the default values set by Docker. This parameter maps to Ulimits
in the Create a container section of the
Docker Remote API and the --ulimit
option to
docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the
exception of the nofile
resource limit parameter which Fargate overrides. The nofile
resource limit sets a restriction on the number of open files that a container can use. The default
nofile
soft limit is 1024
and the default hard limit is 65535
.
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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
ulimits
- A list of ulimits
to set in the container. If a ulimit
value is specified in a
task definition, it overrides the default values set by Docker. This parameter maps to
Ulimits
in the Create a container section
of the Docker Remote API and the
--ulimit
option to docker run. Valid naming
values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with
the exception of the nofile
resource limit parameter which Fargate overrides. The
nofile
resource limit sets a restriction on the number of open files that a container can
use. The default nofile
soft limit is 1024
and the default hard limit is
65535
.
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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
public void setLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
This parameter maps to LogConfig
in the Create a container section of the
Docker Remote API and the --log-driver
option to docker run. By
default, containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on
that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed
on that instance can use these log configuration options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
logConfiguration
- The log configuration specification for the container.
This parameter maps to LogConfig
in the Create a container section
of the Docker Remote API and the
--log-driver
option to docker run. By default,
containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available
on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before
containers placed on that instance can use these log configuration options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
public LogConfiguration getLogConfiguration()
The log configuration specification for the container.
This parameter maps to LogConfig
in the Create a container section of the
Docker Remote API and the --log-driver
option to docker run. By
default, containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on
that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed
on that instance can use these log configuration options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This parameter maps to LogConfig
in the Create a container section
of the Docker Remote API and the
--log-driver
option to docker run. By default,
containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers
available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable
before containers placed on that instance can use these log configuration options. For more information,
see Amazon
ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
public ContainerDefinition withLogConfiguration(LogConfiguration logConfiguration)
The log configuration specification for the container.
This parameter maps to LogConfig
in the Create a container section of the
Docker Remote API and the --log-driver
option to docker run. By
default, containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run the following
command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on
that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed
on that instance can use these log configuration options. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
logConfiguration
- The log configuration specification for the container.
This parameter maps to LogConfig
in the Create a container section
of the Docker Remote API and the
--log-driver
option to docker run. By default,
containers use the same logging driver that the Docker daemon uses. However the container can 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 about 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). Additional 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 in to your container instance and run
the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available
on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before
containers placed on that instance can use these log configuration options. For more information, see Amazon ECS
Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
public void setHealthCheck(HealthCheck healthCheck)
The container health check command and associated configuration parameters for the container. This parameter maps
to HealthCheck
in the Create a container section of the
Docker Remote API and the HEALTHCHECK
parameter of docker run.
healthCheck
- The container health check command and associated configuration parameters for the container. This
parameter maps to HealthCheck
in the Create a container section
of the Docker Remote API and the
HEALTHCHECK
parameter of docker run.public HealthCheck getHealthCheck()
The container health check command and associated configuration parameters for the container. This parameter maps
to HealthCheck
in the Create a container section of the
Docker Remote API and the HEALTHCHECK
parameter of docker run.
HealthCheck
in the Create a container section
of the Docker Remote API and the
HEALTHCHECK
parameter of docker run.public ContainerDefinition withHealthCheck(HealthCheck healthCheck)
The container health check command and associated configuration parameters for the container. This parameter maps
to HealthCheck
in the Create a container section of the
Docker Remote API and the HEALTHCHECK
parameter of docker run.
healthCheck
- The container health check command and associated configuration parameters for the container. This
parameter maps to HealthCheck
in the Create a container section
of the Docker Remote API and the
HEALTHCHECK
parameter of docker run.public List<SystemControl> getSystemControls()
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in
the Create a container section
of the Docker Remote API and the --sysctl
option to docker run. For
example, you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.
Sysctls
in the Create a container section
of the Docker Remote API and the
--sysctl
option to docker run. For example,
you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.public void setSystemControls(Collection<SystemControl> systemControls)
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in
the Create a container section
of the Docker Remote API and the --sysctl
option to docker run. For
example, you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.
systemControls
- A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in the Create a container section
of the Docker Remote API and the
--sysctl
option to docker run. For example,
you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.public ContainerDefinition withSystemControls(SystemControl... systemControls)
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in
the Create a container section
of the Docker Remote API and the --sysctl
option to docker run. For
example, you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.
NOTE: This method appends the values to the existing list (if any). Use
setSystemControls(java.util.Collection)
or withSystemControls(java.util.Collection)
if you want
to override the existing values.
systemControls
- A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in the Create a container section
of the Docker Remote API and the
--sysctl
option to docker run. For example,
you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.public ContainerDefinition withSystemControls(Collection<SystemControl> systemControls)
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in
the Create a container section
of the Docker Remote API and the --sysctl
option to docker run. For
example, you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.
systemControls
- A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in the Create a container section
of the Docker Remote API and the
--sysctl
option to docker run. For example,
you can configure net.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.public List<ResourceRequirement> getResourceRequirements()
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
public void setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
resourceRequirements
- The type and amount of a resource to assign to a container. The only supported resource is a GPU.public ContainerDefinition withResourceRequirements(ResourceRequirement... resourceRequirements)
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
NOTE: This method appends the values to the existing list (if any). Use
setResourceRequirements(java.util.Collection)
or withResourceRequirements(java.util.Collection)
if you want to override the existing values.
resourceRequirements
- The type and amount of a resource to assign to a container. The only supported resource is a GPU.public ContainerDefinition withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
resourceRequirements
- The type and amount of a resource to assign to a container. The only supported resource is a GPU.public void setFirelensConfiguration(FirelensConfiguration firelensConfiguration)
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
firelensConfiguration
- The FireLens configuration for the container. This is used to specify and configure a log router for
container logs. For more information, see Custom Log
Routing in the Amazon Elastic Container Service Developer Guide.public FirelensConfiguration getFirelensConfiguration()
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
public ContainerDefinition withFirelensConfiguration(FirelensConfiguration firelensConfiguration)
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
firelensConfiguration
- The FireLens configuration for the container. This is used to specify and configure a log router for
container logs. For more information, see Custom Log
Routing in the Amazon Elastic Container Service Developer Guide.public List<String> getCredentialSpecs()
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional section
for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN in
Secrets Manager for a secret containing the username, password, and the domain to connect to. For better
security, the instance isn't joined to the domain for domainless authentication. Other applications on the
instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even
it the tasks need to join different domains. For more information, see Using gMSAs for Windows
Containers and Using
gMSAs for Linux Containers.
CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional
section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a
ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For
better security, the instance isn't joined to the domain for domainless authentication. Other
applications on the instance can't use the domainless credentials. You can use this parameter to run
tasks on the same instance, even it the tasks need to join different domains. For more information, see
Using gMSAs for
Windows Containers and Using gMSAs for Linux
Containers.
public void setCredentialSpecs(Collection<String> credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional section
for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN in
Secrets Manager for a secret containing the username, password, and the domain to connect to. For better
security, the instance isn't joined to the domain for domainless authentication. Other applications on the
instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even
it the tasks need to join different domains. For more information, see Using gMSAs for Windows
Containers and Using
gMSAs for Linux Containers.
credentialSpecs
- A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional
section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN
in Secrets Manager for a secret containing the username, password, and the domain to connect to. For
better security, the instance isn't joined to the domain for domainless authentication. Other applications
on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same
instance, even it the tasks need to join different domains. For more information, see Using gMSAs for
Windows Containers and Using gMSAs for Linux
Containers.
public ContainerDefinition withCredentialSpecs(String... credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional section
for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN in
Secrets Manager for a secret containing the username, password, and the domain to connect to. For better
security, the instance isn't joined to the domain for domainless authentication. Other applications on the
instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even
it the tasks need to join different domains. For more information, see Using gMSAs for Windows
Containers and Using
gMSAs for Linux Containers.
NOTE: This method appends the values to the existing list (if any). Use
setCredentialSpecs(java.util.Collection)
or withCredentialSpecs(java.util.Collection)
if you
want to override the existing values.
credentialSpecs
- A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional
section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN
in Secrets Manager for a secret containing the username, password, and the domain to connect to. For
better security, the instance isn't joined to the domain for domainless authentication. Other applications
on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same
instance, even it the tasks need to join different domains. For more information, see Using gMSAs for
Windows Containers and Using gMSAs for Linux
Containers.
public ContainerDefinition withCredentialSpecs(Collection<String> credentialSpecs)
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional section
for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN in
Secrets Manager for a secret containing the username, password, and the domain to connect to. For better
security, the instance isn't joined to the domain for domainless authentication. Other applications on the
instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even
it the tasks need to join different domains. For more information, see Using gMSAs for Windows
Containers and Using
gMSAs for Linux Containers.
credentialSpecs
- A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec
) file that configures the
container for Active Directory authentication. We recommend that you use this parameter instead of the
dockerSecurityOptions
. The maximum number of ARNs is 1.
There are two formats for each ARN.
You use credentialspecdomainless:MyARN
to provide a CredSpec
with an additional
section for a secret in Secrets Manager. You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different domains.
You can use this format without joining the container instance to a domain.
You use credentialspec:MyARN
to provide a CredSpec
for a single domain.
You must join the container instance to the domain before you start any tasks that use this task definition.
In both formats, replace MyARN
with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN
, the credspec
must provide a ARN
in Secrets Manager for a secret containing the username, password, and the domain to connect to. For
better security, the instance isn't joined to the domain for domainless authentication. Other applications
on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same
instance, even it the tasks need to join different domains. For more information, see Using gMSAs for
Windows Containers and Using gMSAs for Linux
Containers.
public String toString()
toString
in class Object
Object.toString()
public ContainerDefinition clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.