ecs/aws.sdk.kotlin.services.ecs.model/ContainerDefinition/Builder

Builder

Properties

The command that's passed to the container. This parameter maps to Cmd in the docker container create command and the COMMAND parameter to docker run. If there are multiple arguments, each argument is a separated string in the array.

cpu

var cpu: Int

The number of cpu units reserved for the container. This parameter maps to CpuShares in the docker container create commandand the --cpu-shares option to docker run.

credentialSpecs

var credentialSpecs: List<String>?

A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the dockerSecurityOptions. The maximum number of ARNs is 1.

dependsOn

var dependsOn: List<ContainerDependency>?

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.

disableNetworking

var disableNetworking: Boolean?

When this parameter is true, networking is off within the container. This parameter maps to NetworkDisabled in the docker container create command.

dnsSearchDomains

var dnsSearchDomains: List<String>?

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the docker container create command and the --dns-search option to docker run.

dnsServers

var dnsServers: List<String>?

A list of DNS servers that are presented to the container. This parameter maps to Dns in the docker container create command and the --dns option to docker run.

dockerLabels

var dockerLabels: Map<String, String>?

A key/value map of labels to add to the container. This parameter maps to Labels in the docker container create command 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}}'

dockerSecurityOptions

var dockerSecurityOptions: List<String>?

A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.

entryPoint

var entryPoint: List<String>?

Early versions of the Amazon ECS container agent don't properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

environment

var environment: List<KeyValuePair>?

The environment variables to pass to a container. This parameter maps to Env in the docker container create command and the --env option to docker run.

environmentFiles

var environmentFiles: List<EnvironmentFile>?

A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.

essential

var essential: Boolean?

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

extraHosts

var extraHosts: List<HostEntry>?

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the docker container create command and the --add-host option to docker run.

firelensConfiguration

var firelensConfiguration: FirelensConfiguration?

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

healthCheck

var healthCheck: HealthCheck?

The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the docker container create command and the HEALTHCHECK parameter of docker run.

hostname

var hostname: String?

The hostname to use for your container. This parameter maps to Hostname in the docker container create command and the --hostname option to docker run.

image

var image: String?

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . For images using tags (repository-url/image:tag), up to 255 characters total are allowed, including letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs (#). For images using digests (repository-url/image@digest), the 255 character limit applies only to the repository URL and image name (everything before the @ sign). The only supported hash function is sha256, and the hash value after sha256: must be exactly 64 characters (only letters A-F, a-f, and numbers 0-9 are allowed). This parameter maps to Image in the docker container create command and the IMAGE parameter of docker run.

interactive

var interactive: Boolean?

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the docker container create command and the --interactive option to docker run.

links

var links: List<String>?

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker container create command and the --link option to docker run.

linuxParameters

var linuxParameters: LinuxParameters?

Linux-specific modifications that are applied to the default Docker container configuration, such as Linux kernel capabilities. For more information see KernelCapabilities.

logConfiguration

var logConfiguration: LogConfiguration?

The log configuration specification for the container.

memory

var memory: Int?

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the docker container create command and the --memory option to docker run.

memoryReservation

var memoryReservation: Int?

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the docker container create command and the --memory-reservation option to docker run.

mountPoints

var mountPoints: List<MountPoint>?

The mount points for data volumes in your container.

name

var name: String?

The name of a container. If you're linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container create command and the --name option to docker run.

portMappings

var portMappings: List<PortMapping>?

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.

privileged

var privileged: Boolean?

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the docker container create command and the --privileged option to docker run

pseudoTerminal

var pseudoTerminal: Boolean?

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the docker container create command and the --tty option to docker run.

readonlyRootFilesystem

var readonlyRootFilesystem: Boolean?

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the docker container create command and the --read-only option to docker run.

repositoryCredentials

var repositoryCredentials: RepositoryCredentials?

The private repository authentication credentials to use.

resourceRequirements

var resourceRequirements: List<ResourceRequirement>?

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

restartPolicy

var restartPolicy: ContainerRestartPolicy?

The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.

secrets

var secrets: List<Secret>?

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

startTimeout

var startTimeout: Int?

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a STOPPED state.

stopTimeout

var stopTimeout: Int?

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

systemControls

var systemControls: List<SystemControl>?

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.

ulimits

var ulimits: List<Ulimit>?

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the docker container create command and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type.

user

var user: String?

The user to use inside the container. This parameter maps to User in the docker container create command and the --user option to docker run.

versionConsistency

var versionConsistency: VersionConsistency?

Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is enabled. If you set the value for a container as disabled, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see Container image resolution in the Amazon ECS Developer Guide.

volumesFrom

var volumesFrom: List<VolumeFrom>?

Data volumes to mount from another container. This parameter maps to VolumesFrom in the docker container create command and the --volumes-from option to docker run.

workingDirectory

var workingDirectory: String?

The working directory to run commands inside the container in. This parameter maps to WorkingDir in the docker container create command and the --workdir option to docker run.