Interface ContainerDefinition.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ContainerDefinition.Builder,
,ContainerDefinition> SdkBuilder<ContainerDefinition.Builder,
,ContainerDefinition> SdkPojo
- Enclosing class:
ContainerDefinition
-
Method Summary
Modifier and TypeMethodDescriptionThe command that's passed to the container.command
(Collection<String> command) The command that's passed to the container.The number ofcpu
units reserved for the container.credentialSpecs
(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.credentialSpecs
(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.dependsOn
(Collection<ContainerDependency> dependsOn) The dependencies defined for container startup and shutdown.dependsOn
(Consumer<ContainerDependency.Builder>... dependsOn) The dependencies defined for container startup and shutdown.dependsOn
(ContainerDependency... dependsOn) The dependencies defined for container startup and shutdown.disableNetworking
(Boolean disableNetworking) When this parameter is true, networking is off within the container.dnsSearchDomains
(String... dnsSearchDomains) A list of DNS search domains that are presented to the container.dnsSearchDomains
(Collection<String> dnsSearchDomains) A list of DNS search domains that are presented to the container.dnsServers
(String... dnsServers) A list of DNS servers that are presented to the container.dnsServers
(Collection<String> dnsServers) A list of DNS servers that are presented to the container.dockerLabels
(Map<String, String> dockerLabels) A key/value map of labels to add to the container.dockerSecurityOptions
(String... dockerSecurityOptions) A list of strings to provide custom configuration for multiple security systems.dockerSecurityOptions
(Collection<String> dockerSecurityOptions) A list of strings to provide custom configuration for multiple security systems.entryPoint
(String... entryPoint) entryPoint
(Collection<String> entryPoint) environment
(Collection<KeyValuePair> environment) The environment variables to pass to a container.environment
(Consumer<KeyValuePair.Builder>... environment) The environment variables to pass to a container.environment
(KeyValuePair... environment) The environment variables to pass to a container.environmentFiles
(Collection<EnvironmentFile> environmentFiles) A list of files containing the environment variables to pass to a container.environmentFiles
(Consumer<EnvironmentFile.Builder>... environmentFiles) A list of files containing the environment variables to pass to a container.environmentFiles
(EnvironmentFile... environmentFiles) A list of files containing the environment variables to pass to a container.If theessential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped.extraHosts
(Collection<HostEntry> extraHosts) A list of hostnames and IP address mappings to append to the/etc/hosts
file on the container.extraHosts
(Consumer<HostEntry.Builder>... extraHosts) A list of hostnames and IP address mappings to append to the/etc/hosts
file on the container.extraHosts
(HostEntry... extraHosts) A list of hostnames and IP address mappings to append to the/etc/hosts
file on the container.default ContainerDefinition.Builder
firelensConfiguration
(Consumer<FirelensConfiguration.Builder> firelensConfiguration) The FireLens configuration for the container.firelensConfiguration
(FirelensConfiguration firelensConfiguration) The FireLens configuration for the container.default ContainerDefinition.Builder
healthCheck
(Consumer<HealthCheck.Builder> healthCheck) The container health check command and associated configuration parameters for the container.healthCheck
(HealthCheck healthCheck) The container health check command and associated configuration parameters for the container.The hostname to use for your container.The image used to start a container.interactive
(Boolean interactive) When this parameter istrue
, you can deploy containerized applications that requirestdin
or atty
to be allocated.Thelinks
parameter allows containers to communicate with each other without the need for port mappings.links
(Collection<String> links) Thelinks
parameter allows containers to communicate with each other without the need for port mappings.default ContainerDefinition.Builder
linuxParameters
(Consumer<LinuxParameters.Builder> linuxParameters) Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.linuxParameters
(LinuxParameters linuxParameters) Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.default ContainerDefinition.Builder
logConfiguration
(Consumer<LogConfiguration.Builder> logConfiguration) The log configuration specification for the container.logConfiguration
(LogConfiguration logConfiguration) The log configuration specification for the container.The amount (in MiB) of memory to present to the container.memoryReservation
(Integer memoryReservation) The soft limit (in MiB) of memory to reserve for the container.mountPoints
(Collection<MountPoint> mountPoints) The mount points for data volumes in your container.mountPoints
(Consumer<MountPoint.Builder>... mountPoints) The mount points for data volumes in your container.mountPoints
(MountPoint... mountPoints) The mount points for data volumes in your container.The name of a container.portMappings
(Collection<PortMapping> portMappings) The list of port mappings for the container.portMappings
(Consumer<PortMapping.Builder>... portMappings) The list of port mappings for the container.portMappings
(PortMapping... portMappings) The list of port mappings for the container.privileged
(Boolean privileged) When this parameter is true, the container is given elevated privileges on the host container instance (similar to theroot
user).pseudoTerminal
(Boolean pseudoTerminal) When this parameter istrue
, a TTY is allocated.readonlyRootFilesystem
(Boolean readonlyRootFilesystem) When this parameter is true, the container is given read-only access to its root file system.default ContainerDefinition.Builder
repositoryCredentials
(Consumer<RepositoryCredentials.Builder> repositoryCredentials) The private repository authentication credentials to use.repositoryCredentials
(RepositoryCredentials repositoryCredentials) The private repository authentication credentials to use.resourceRequirements
(Collection<ResourceRequirement> resourceRequirements) The type and amount of a resource to assign to a container.resourceRequirements
(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of a resource to assign to a container.resourceRequirements
(ResourceRequirement... resourceRequirements) The type and amount of a resource to assign to a container.secrets
(Collection<Secret> secrets) The secrets to pass to the container.secrets
(Consumer<Secret.Builder>... secrets) The secrets to pass to the container.The secrets to pass to the container.startTimeout
(Integer startTimeout) Time duration (in seconds) to wait before giving up on resolving dependencies for a container.stopTimeout
(Integer stopTimeout) Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.systemControls
(Collection<SystemControl> systemControls) A list of namespaced kernel parameters to set in the container.systemControls
(Consumer<SystemControl.Builder>... systemControls) A list of namespaced kernel parameters to set in the container.systemControls
(SystemControl... systemControls) A list of namespaced kernel parameters to set in the container.ulimits
(Collection<Ulimit> ulimits) A list ofulimits
to set in the container.ulimits
(Consumer<Ulimit.Builder>... ulimits) A list ofulimits
to set in the container.A list ofulimits
to set in the container.The user to use inside the container.volumesFrom
(Collection<VolumeFrom> volumesFrom) Data volumes to mount from another container.volumesFrom
(Consumer<VolumeFrom.Builder>... volumesFrom) Data volumes to mount from another container.volumesFrom
(VolumeFrom... volumesFrom) Data volumes to mount from another container.workingDirectory
(String workingDirectory) The working directory to run commands inside the container in.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps toname
in the Create a container section of the Docker Remote API and the--name
option to docker run.- Parameters:
name
- The name of a container. If you're linking multiple containers together in a task definition, thename
of one container can be entered in thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps toname
in the Create a container section of the Docker Remote API and the--name
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
orrepository-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 toImage
in the Create a container section of the Docker Remote API and theIMAGE
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
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
- Parameters:
image
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with eitherrepository-url/image:tag
orrepository-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 toImage
in the Create a container section of the Docker Remote API and theIMAGE
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
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
repositoryCredentials
The private repository authentication credentials to use.
- Parameters:
repositoryCredentials
- The private repository authentication credentials to use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repositoryCredentials
default ContainerDefinition.Builder repositoryCredentials(Consumer<RepositoryCredentials.Builder> repositoryCredentials) The private repository authentication credentials to use.
This is a convenience method that creates an instance of theRepositoryCredentials.Builder
avoiding the need to create one manually viaRepositoryCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torepositoryCredentials(RepositoryCredentials)
.- Parameters:
repositoryCredentials
- a consumer that will call methods onRepositoryCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cpu
The number of
cpu
units reserved for the container. This parameter maps toCpuShares
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.- Parameters:
cpu
- The number ofcpu
units reserved for the container. This parameter maps toCpuShares
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 toMemory
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
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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.
- Parameters:
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 taskmemory
value, if one is specified. This parameter maps toMemory
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
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toMemoryReservation
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
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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 amemory
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.
- Parameters:
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 thememory
parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservation
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
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemory
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 amemory
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isbridge
. Thename:internalName
construct is analogous toname: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 toLinks
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.
- Parameters:
links
- Thelinks
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 isbridge
. Thename:internalName
construct is analogous toname: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 toLinks
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isbridge
. Thename:internalName
construct is analogous toname: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 toLinks
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.
- Parameters:
links
- Thelinks
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 isbridge
. Thename:internalName
construct is analogous toname: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 toLinks
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. 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 tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, 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 thenetworkBindings
section DescribeTasks responses.- Parameters:
portMappings
- The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.For task definitions that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. 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 tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, 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 thenetworkBindings
section DescribeTasks responses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. 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 tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, 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 thenetworkBindings
section DescribeTasks responses.- Parameters:
portMappings
- The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.For task definitions that use the
awsvpc
network mode, only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. 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 tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, 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 thenetworkBindings
section DescribeTasks responses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. 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 tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, 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 thenetworkBindings
section DescribeTasks responses.PortMapping.Builder
avoiding the need to create one manually viaPortMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toportMappings(List<PortMapping>)
.- Parameters:
portMappings
- a consumer that will call methods onPortMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
essential
If the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, 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.
- Parameters:
essential
- If theessential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entryPoint
Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
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.- Parameters:
entryPoint
-Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
entryPoint
Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
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.- Parameters:
entryPoint
-Early versions of the Amazon ECS container agent don't properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theCOMMAND
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.- Parameters:
command
- The command that's passed to the container. This parameter maps toCmd
in the Create a container section of the Docker Remote API and theCOMMAND
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theCOMMAND
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.- Parameters:
command
- The command that's passed to the container. This parameter maps toCmd
in the Create a container section of the Docker Remote API and theCOMMAND
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
environment
- The environment variables to pass to a container. This parameter maps toEnv
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
environment
- The environment variables to pass to a container. This parameter maps toEnv
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
KeyValuePair.Builder
avoiding the need to create one manually viaKeyValuePair.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironment(List<KeyValuePair>)
.- Parameters:
environment
- a consumer that will call methods onKeyValuePair.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 inVARIABLE=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.- Parameters:
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 inVARIABLE=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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 inVARIABLE=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.- Parameters:
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 inVARIABLE=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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 inVARIABLE=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
This is a convenience method that creates an instance of theenvironment
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.EnvironmentFile.Builder
avoiding the need to create one manually viaEnvironmentFile.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironmentFiles(List<EnvironmentFile>)
.- Parameters:
environmentFiles
- a consumer that will call methods onEnvironmentFile.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of the$env:ProgramData
. Windows containers can't mount directories on a different drive, and mount point can't be across drives.MountPoint.Builder
avoiding the need to create one manually viaMountPoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomountPoints(List<MountPoint>)
.- Parameters:
mountPoints
- a consumer that will call methods onMountPoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
volumesFrom
- Data volumes to mount from another container. This parameter maps toVolumesFrom
in the Create a container section of the Docker Remote API and the--volumes-from
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
volumesFrom
- Data volumes to mount from another container. This parameter maps toVolumesFrom
in the Create a container section of the Docker Remote API and the--volumes-from
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumesFrom
Data volumes to mount from another container. This parameter maps to
This is a convenience method that creates an instance of theVolumesFrom
in the Create a container section of the Docker Remote API and the--volumes-from
option to docker run.VolumeFrom.Builder
avoiding the need to create one manually viaVolumeFrom.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovolumesFrom(List<VolumeFrom>)
.- Parameters:
volumesFrom
- a consumer that will call methods onVolumeFrom.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linuxParameters
default ContainerDefinition.Builder linuxParameters(Consumer<LinuxParameters.Builder> 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.Builder
avoiding the need to create one manually viaLinuxParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolinuxParameters(LinuxParameters)
.- Parameters:
linuxParameters
- a consumer that will call methods onLinuxParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secrets
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Parameters:
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secrets
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Parameters:
secrets
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secrets
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
This is a convenience method that creates an instance of theSecret.Builder
avoiding the need to create one manually viaSecret.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecrets(List<Secret>)
.- Parameters:
secrets
- a consumer that will call methods onSecret.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 version20190301
or later, then they contain the required versions of the container agent andecs-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.
- Parameters:
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 version20190301
or later, then they contain the required versions of the container agent andecs-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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 version20190301
or later, then they contain the required versions of the container agent andecs-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.
- Parameters:
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 version20190301
or later, then they contain the required versions of the container agent andecs-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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 version20190301
or later, then they contain the required versions of the container agent andecs-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.
ContainerDependency.Builder
avoiding the need to create one manually viaContainerDependency.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todependsOn(List<ContainerDependency>)
.- Parameters:
dependsOn
- a consumer that will call methods onContainerDependency.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
, orHEALTHY
status. If astartTimeout
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 aSTOPPED
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 version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-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.
- Parameters:
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 aCOMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
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 aSTOPPED
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 version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_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 theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-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.
- Parameters:
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 variableECS_CONTAINER_STOP_TIMEOUT
is used. If neither thestopTimeout
parameter or theECS_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 theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theawsvpc
network mode.- Parameters:
hostname
- The hostname to use for your container. This parameter maps toHostname
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 theawsvpc
network mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
user
- The user to use inside the container. This parameter maps toUser
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- Parameters:
workingDirectory
- The working directory to run commands inside the container in. This parameter maps toWorkingDir
in the Create a container section of the Docker Remote API and the--workdir
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
disableNetworking
- When this parameter is true, networking is off within the container. This parameter maps toNetworkDisabled
in the Create a container section of the Docker Remote API.This parameter is not supported for Windows containers.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toPrivileged
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.
- Parameters:
privileged
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to theroot
user). This parameter maps toPrivileged
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfs
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
dnsServers
- A list of DNS servers that are presented to the container. This parameter maps toDns
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
dnsServers
- A list of DNS servers that are presented to the container. This parameter maps toDns
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
dnsSearchDomains
- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearch
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
dnsSearchDomains
- A list of DNS search domains that are presented to the container. This parameter maps toDnsSearch
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
extraHosts
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
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.- Parameters:
extraHosts
- A list of hostnames and IP address mappings to append to the/etc/hosts
file on the container. This parameter maps toExtraHosts
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
extraHosts
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
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.- Parameters:
extraHosts
- A list of hostnames and IP address mappings to append to the/etc/hosts
file on the container. This parameter maps toExtraHosts
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
extraHosts
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
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.HostEntry.Builder
avoiding the need to create one manually viaHostEntry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toextraHosts(List<HostEntry>)
.- Parameters:
extraHosts
- a consumer that will call methods onHostEntry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
orECS_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"
- Parameters:
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
orECS_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"
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
orECS_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"
- Parameters:
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
orECS_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"
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
interactive
When this parameter is
true
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the Create a container section of the Docker Remote API and the--interactive
option to docker run.- Parameters:
interactive
- When this parameter istrue
, you can deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the Create a container section of the Docker Remote API and the--interactive
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pseudoTerminal
When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in the Create a container section of the Docker Remote API and the--tty
option to docker run.- Parameters:
pseudoTerminal
- When this parameter istrue
, a TTY is allocated. This parameter maps toTty
in the Create a container section of the Docker Remote API and the--tty
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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}}'
- Parameters:
dockerLabels
- A key/value map of labels to add to the container. This parameter maps toLabels
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}}'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
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. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is1024
and the default hard limit is65535
.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.
- Parameters:
ulimits
- A list ofulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
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. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is1024
and the default hard limit is65535
.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
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. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is1024
and the default hard limit is65535
.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.
- Parameters:
ulimits
- A list ofulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
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. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is1024
and the default hard limit is65535
.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. If aulimit
value is specified in a task definition, it overrides the default values set by Docker. This parameter maps toUlimits
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. Thenofile
resource limit sets a restriction on the number of open files that a container can use. The defaultnofile
soft limit is1024
and the default hard limit is65535
.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.
Ulimit.Builder
avoiding the need to create one manually viaUlimit.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toulimits(List<Ulimit>)
.- Parameters:
ulimits
- a consumer that will call methods onUlimit.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfiguration
default ContainerDefinition.Builder logConfiguration(Consumer<LogConfiguration.Builder> 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.Builder
avoiding the need to create one manually viaLogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfiguration(LogConfiguration)
.- Parameters:
logConfiguration
- a consumer that will call methods onLogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theHEALTHCHECK
parameter of docker run.- Parameters:
healthCheck
- The container health check command and associated configuration parameters for the container. This parameter maps toHealthCheck
in the Create a container section of the Docker Remote API and theHEALTHCHECK
parameter of docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheck
The container health check command and associated configuration parameters for the container. This parameter maps to
This is a convenience method that creates an instance of theHealthCheck
in the Create a container section of the Docker Remote API and theHEALTHCHECK
parameter of docker run.HealthCheck.Builder
avoiding the need to create one manually viaHealthCheck.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohealthCheck(HealthCheck)
.- Parameters:
healthCheck
- a consumer that will call methods onHealthCheck.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.- Parameters:
systemControls
- A list of namespaced kernel parameters to set in the container. This parameter maps toSysctls
in the Create a container section of the Docker Remote API and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.- Parameters:
systemControls
- A list of namespaced kernel parameters to set in the container. This parameter maps toSysctls
in the Create a container section of the Docker Remote API and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
systemControls
A list of namespaced kernel parameters to set in the container. This parameter maps to
This is a convenience method that creates an instance of theSysctls
in the Create a container section of the Docker Remote API and the--sysctl
option to docker run. For example, you can configurenet.ipv4.tcp_keepalive_time
setting to maintain longer lived connections.SystemControl.Builder
avoiding the need to create one manually viaSystemControl.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosystemControls(List<SystemControl>)
.- Parameters:
systemControls
- a consumer that will call methods onSystemControl.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceRequirements
ContainerDefinition.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements) The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Parameters:
resourceRequirements
- The type and amount of a resource to assign to a container. The only supported resource is a GPU.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Parameters:
resourceRequirements
- The type and amount of a resource to assign to a container. The only supported resource is a GPU.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
ContainerDefinition.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of a resource to assign to a container. The only supported resource is a GPU.
This is a convenience method that creates an instance of theResourceRequirement.Builder
avoiding the need to create one manually viaResourceRequirement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceRequirements(List<ResourceRequirement>)
.- Parameters:
resourceRequirements
- a consumer that will call methods onResourceRequirement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
firelensConfiguration
default ContainerDefinition.Builder firelensConfiguration(Consumer<FirelensConfiguration.Builder> 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.
This is a convenience method that creates an instance of theFirelensConfiguration.Builder
avoiding the need to create one manually viaFirelensConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofirelensConfiguration(FirelensConfiguration)
.- Parameters:
firelensConfiguration
- a consumer that will call methods onFirelensConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
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.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
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
, thecredspec
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.- Parameters:
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 thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
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.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
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
, thecredspec
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
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.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
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
, thecredspec
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.- Parameters:
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 thedockerSecurityOptions
. The maximum number of ARNs is 1.There are two formats for each ARN.
- credentialspecdomainless:MyARN
-
You use
credentialspecdomainless:MyARN
to provide aCredSpec
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.
- credentialspec:MyARN
-
You use
credentialspec:MyARN
to provide aCredSpec
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
, thecredspec
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-