class ContainerDefinition (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ECS.ContainerDefinition
Java	software.amazon.awscdk.services.ecs.ContainerDefinition
Python	aws_cdk.aws_ecs.ContainerDefinition
TypeScript (source)	@aws-cdk/aws-ecs » ContainerDefinition

Implements IConstruct, IConstruct, IDependable

A container definition is used in a task definition to describe the containers that are launched as part of a task.

Example

declare const taskDefinition: ecs.TaskDefinition;
declare const cluster: ecs.Cluster;

// Add a container to the task definition
const specificContainer = taskDefinition.addContainer('Container', {
  image: ecs.ContainerImage.fromRegistry('/aws/aws-example-app'),
  memoryLimitMiB: 2048,
});

// Add a port mapping
specificContainer.addPortMappings({
  containerPort: 7600,
  protocol: ecs.Protocol.TCP,
});

new ecs.Ec2Service(this, 'Service', {
  cluster,
  taskDefinition,
  cloudMapOptions: {
    // Create SRV records - useful for bridge networking
    dnsRecordType: cloudmap.DnsRecordType.SRV,
    // Targets port TCP port 7600 `specificContainer`
    container: specificContainer,
    containerPort: 7600,
  },
});

Initializer

new ContainerDefinition(scope: Construct, id: string, props: ContainerDefinitionProps)

Parameters

• scope Construct
• id string
• props ContainerDefinitionProps

Constructs a new instance of the ContainerDefinition class.

Construct Props

Name	Type	Description
image	ContainerImage	The image used to start a container.
taskDefinition	TaskDefinition	The name of the task definition that includes this container definition.
command?	string[]	The command that is passed to the container.
containerName?	string	The name of the container.
cpu?	number	The minimum number of CPU units to reserve for the container.
disableNetworking?	boolean	Specifies whether networking is disabled within the container.
dnsSearchDomains?	string[]	A list of DNS search domains that are presented to the container.
dnsServers?	string[]	A list of DNS servers that are presented to the container.
dockerLabels?	{ [string]: string }	A key/value map of labels to add to the container.
dockerSecurityOptions?	string[]	A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
entryPoint?	string[]	The ENTRYPOINT value to pass to the container.
environment?	{ [string]: string }	The environment variables to pass to the container.
environmentFiles?	EnvironmentFile[]	The environment files to pass to the container.
essential?	boolean	Specifies whether the container is marked essential.
extraHosts?	{ [string]: string }	A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
gpuCount?	number	The number of GPUs assigned to the container.
healthCheck?	HealthCheck	The health check command and associated configuration parameters for the container.
hostname?	string	The hostname to use for your container.
inferenceAcceleratorResources?	string[]	The inference accelerators referenced by the container.
linuxParameters?	LinuxParameters	Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
logging?	LogDriver	The log configuration specification for the container.
memoryLimitMiB?	number	The amount (in MiB) of memory to present to the container.
memoryReservationMiB?	number	The soft limit (in MiB) of memory to reserve for the container.
portMappings?	PortMapping[]	The port mappings to add to the container definition.
privileged?	boolean	Specifies whether the container is marked as privileged.
readonlyRootFilesystem?	boolean	When this parameter is true, the container is given read-only access to its root file system.
secrets?	{ [string]: Secret }	The secret environment variables to pass to the container.
startTimeout?	Duration	Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
stopTimeout?	Duration	Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
systemControls?	SystemControl[]	A list of namespaced kernel parameters to set in the container.
user?	string	The user name to use inside the container.
workingDirectory?	string	The working directory in which to run commands inside the container.

---

image

Type: ContainerImage

The image used to start a container.

This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. TODO: Update these to specify using classes of IContainerImage

---

taskDefinition

Type: TaskDefinition

The name of the task definition that includes this container definition.

[disable-awslint:ref-via-interface]

---

command?

Type: string[] (optional, default: CMD value built into container image.)

The command that is passed to the container.

If you provide a shell command as a single string, you have to quote command-line arguments.

---

containerName?

Type: string (optional, default: id of node associated with ContainerDefinition.)

The name of the container.

---

cpu?

Type: number (optional, default: No minimum CPU units reserved.)

The minimum number of CPU units to reserve for the container.

---

disableNetworking?

Type: boolean (optional, default: false)

Specifies whether networking is disabled within the container.

When this parameter is true, networking is disabled within the container.

---

dnsSearchDomains?

Type: string[] (optional, default: No search domains.)

A list of DNS search domains that are presented to the container.

---

dnsServers?

Type: string[] (optional, default: Default DNS servers.)

A list of DNS servers that are presented to the container.

---

dockerLabels?

Type: { [string]: string } (optional, default: No labels.)

A key/value map of labels to add to the container.

---

dockerSecurityOptions?

Type: string[] (optional, default: No security labels.)

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

---

entryPoint?

Type: string[] (optional, default: Entry point configured in container.)

The ENTRYPOINT value to pass to the container.

See also: https://docs.docker.com/engine/reference/builder/#entrypoint

---

environment?

Type: { [string]: string } (optional, default: No environment variables.)

The environment variables to pass to the container.

---

environmentFiles?

Type: EnvironmentFile[] (optional, default: No environment files.)

The environment files to pass to the container.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

---

essential?

Type: boolean (optional, default: true)

Specifies whether the container is marked essential.

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. All tasks must have at least one essential container.

If this parameter is omitted, a container is assumed to be essential.

---

extraHosts?

Type: { [string]: string } (optional, default: No extra hosts.)

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

---

gpuCount?

Type: number (optional, default: No GPUs assigned.)

The number of GPUs assigned to the container.

---

healthCheck?

Type: HealthCheck (optional, default: Health check configuration from container.)

The health check command and associated configuration parameters for the container.

---

hostname?

Type: string (optional, default: Automatic hostname.)

The hostname to use for your container.

---

inferenceAcceleratorResources?

Type: string[] (optional, default: No inference accelerators assigned.)

The inference accelerators referenced by the container.

---

linuxParameters?

Type: LinuxParameters (optional, default: No Linux parameters.)

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

For more information see KernelCapabilities.

---

logging?

Type: LogDriver (optional, default: Containers use the same logging driver that the Docker daemon uses.)

The log configuration specification for the container.

---

memoryLimitMiB?

Type: number (optional, default: No memory limit.)

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

---

memoryReservationMiB?

Type: number (optional, default: No memory reserved.)

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.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

---

portMappings?

Type: PortMapping[] (optional, default: No ports are mapped.)

The port mappings to add to the container definition.

---

privileged?

Type: boolean (optional, default: false)

Specifies whether the container is marked as privileged.

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

---

readonlyRootFilesystem?

Type: boolean (optional, default: false)

When this parameter is true, the container is given read-only access to its root file system.

---

secrets?

Type: { [string]: Secret } (optional, default: No secret environment variables.)

The secret environment variables to pass to the container.

---

startTimeout?

Type: Duration (optional, default: none)

Time duration (in seconds) to wait before giving up on resolving dependencies for a container.

---

stopTimeout?

Type: Duration (optional, default: none)

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

---

systemControls?

Type: SystemControl[] (optional, default: No system controls are set.)

A list of namespaced kernel parameters to set in the container.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols

---

user?

Type: string (optional, default: root)

The user name to use inside the container.

---

workingDirectory?

Type: string (optional, default: /)

The working directory in which to run commands inside the container.

Properties

Name	Type	Description
containerDependencies	ContainerDependency[]	An array dependencies defined for container startup and shutdown.
containerName	string	The name of this container.
containerPort	number	The port the container will listen on.
essential	boolean	Specifies whether the container will be marked essential.
imageName	string	The name of the image referenced by this container.
ingressPort	number	The inbound rules associated with the security group the task or service will use.
memoryLimitSpecified	boolean	Whether there was at least one memory limit specified in this definition.
mountPoints	MountPoint[]	The mount points for data volumes in your container.
node	ConstructNode	The construct tree node associated with this construct.
portMappings	PortMapping[]	The list of port mappings for the container.
taskDefinition	TaskDefinition	The name of the task definition that includes this container definition.
ulimits	Ulimit[]	An array of ulimits to set in the container.
volumesFrom	VolumeFrom[]	The data volumes to mount from another container in the same task definition.
environmentFiles?	EnvironmentFileConfig[]	The environment files for this container.
linuxParameters?	LinuxParameters	The Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
logDriverConfig?	LogDriverConfig	The log configuration specification for the container.
referencesSecretJsonField?	boolean	Whether this container definition references a specific JSON field of a secret stored in Secrets Manager.

---

containerDependencies

Type: ContainerDependency[]

An array dependencies defined for container startup and shutdown.

---

containerName

Type: string

The name of this container.

---

containerPort

Type: number

The port the container will listen on.

---

essential

Type: boolean

Specifies whether the container will be marked essential.

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task.

If this parameter is omitted, a container is assumed to be essential.

---

imageName

Type: string

The name of the image referenced by this container.

---

ingressPort

Type: number

The inbound rules associated with the security group the task or service will use.

This property is only used for tasks that use the awsvpc network mode.

---

memoryLimitSpecified

Type: boolean

Whether there was at least one memory limit specified in this definition.

---

mountPoints

Type: MountPoint[]

The mount points for data volumes in your container.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

portMappings

Type: 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.

---

taskDefinition

Type: TaskDefinition

The name of the task definition that includes this container definition.

---

ulimits

Type: Ulimit[]

An array of ulimits to set in the container.

---

volumesFrom

Type: VolumeFrom[]

The data volumes to mount from another container in the same task definition.

---

environmentFiles?

Type: EnvironmentFileConfig[] (optional)

The environment files for this container.

---

linuxParameters?

Type: LinuxParameters (optional)

The Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

---

logDriverConfig?

Type: LogDriverConfig (optional)

The log configuration specification for the container.

---

referencesSecretJsonField?

Type: boolean (optional)

Whether this container definition references a specific JSON field of a secret stored in Secrets Manager.

Methods

Name	Description
addContainerDependencies(...containerDependencies)	This method adds one or more container dependencies to the container.
addEnvironment(name, value)	This method adds an environment variable to the container.
addInferenceAcceleratorResource(...inferenceAcceleratorResources)	This method adds one or more resources to the container.
addLink(container, alias?)	This method adds a link which allows containers to communicate with each other without the need for port mappings.
addMountPoints(...mountPoints)	This method adds one or more mount points for data volumes to the container.
addPortMappings(...portMappings)	This method adds one or more port mappings to the container.
addScratch(scratch)	This method mounts temporary disk space to the container.
addToExecutionPolicy(statement)	This method adds the specified statement to the IAM task execution policy in the task definition.
addUlimits(...ulimits)	This method adds one or more ulimits to the container.
addVolumesFrom(...volumesFrom)	This method adds one or more volumes to the container.
findPortMapping(containerPort, protocol)	Returns the host port for the requested container port if it exists.
renderContainerDefinition(_taskDefinition?)	Render this container definition to a CloudFormation object.
toString()	Returns a string representation of this construct.

---

addContainerDependencies(...containerDependencies)

public addContainerDependencies(...containerDependencies: ContainerDependency[]): void

Parameters

• containerDependencies ContainerDependency

This method adds one or more container dependencies to the container.

---

addEnvironment(name, value)

public addEnvironment(name: string, value: string): void

Parameters

• name string
• value string

This method adds an environment variable to the container.

---

addInferenceAcceleratorResource(...inferenceAcceleratorResources)

public addInferenceAcceleratorResource(...inferenceAcceleratorResources: string[]): void

Parameters

• inferenceAcceleratorResources string

This method adds one or more resources to the container.

---

addLink(container, alias?)

public addLink(container: ContainerDefinition, alias?: string): void

Parameters

• container ContainerDefinition
• alias string

This method adds a link which allows containers to communicate with each other without the need for port mappings.

This parameter is only supported if the task definition is using the bridge network mode. Warning: The --link flag is a legacy feature of Docker. It may eventually be removed.

---

addMountPoints(...mountPoints)

public addMountPoints(...mountPoints: MountPoint[]): void

Parameters

• mountPoints MountPoint

This method adds one or more mount points for data volumes to the container.

---

addPortMappings(...portMappings)

public addPortMappings(...portMappings: PortMapping[]): void

Parameters

• portMappings PortMapping

This method adds one or more port mappings to the container.

---

addScratch(scratch)

public addScratch(scratch: ScratchSpace): void

Parameters

• scratch ScratchSpace

This method mounts temporary disk space to the container.

This adds the correct container mountPoint and task definition volume.

---

addToExecutionPolicy(statement)

public addToExecutionPolicy(statement: PolicyStatement): void

Parameters

• statement PolicyStatement

This method adds the specified statement to the IAM task execution policy in the task definition.

---

addUlimits(...ulimits)

public addUlimits(...ulimits: Ulimit[]): void

Parameters

• ulimits Ulimit

This method adds one or more ulimits to the container.

---

addVolumesFrom(...volumesFrom)

public addVolumesFrom(...volumesFrom: VolumeFrom[]): void

Parameters

• volumesFrom VolumeFrom

This method adds one or more volumes to the container.

---

findPortMapping(containerPort, protocol)

public findPortMapping(containerPort: number, protocol: Protocol): PortMapping

Parameters

• containerPort number
• protocol Protocol

Returns

• PortMapping

Returns the host port for the requested container port if it exists.

---

renderContainerDefinition(_taskDefinition?)

public renderContainerDefinition(_taskDefinition?: TaskDefinition): ContainerDefinitionProperty

Parameters

• _taskDefinition TaskDefinition — [disable-awslint:ref-via-interface] (unused but kept to avoid breaking change).

Returns

• ContainerDefinitionProperty

Render this container definition to a CloudFormation object.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.