AWS CDK Reference

Appearance

v2.275.0

EcsContainerOverrideProperty Struct ​

The overrides that are sent to a container.

An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] } . If a non-empty container override is specified, the name parameter must be included.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const ecsContainerOverrideProperty: pipes.CfnPipe.EcsContainerOverrideProperty = {
  command: ['command'],
  cpu: 123,
  environment: [{
    name: 'name',
    value: 'value',
  }],
  environmentFiles: [{
    type: 'type',
    value: 'value',
  }],
  memory: 123,
  memoryReservation: 123,
  name: 'name',
  resourceRequirements: [{
    type: 'type',
    value: 'value',
  }],
};

Properties ​

commandoptionalstring[]commandoptionaltyping.List[str]commandoptionalList<String>Commandoptionalstring[]Commandoptional*[]*string#
The command to send to the container that overrides the default command from the Docker image or the task definition.

You must also specify a container name.

cpuoptionalnumbercpuoptionalint | floatcpuoptionalNumberCpuoptionaldoubleCpuoptional*float64#
The number of `cpu` units reserved for the container, instead of the default value from the task definition.

You must also specify a container name.

environmentoptionalIResolvable | IResolvable | CfnPipe.EcsEnvironmentVariableProperty[]environmentoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EcsEnvironmentVariableProperty]]]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{}#
The environment variables to send to the container.

You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

environmentFilesoptionalIResolvable | IResolvable | CfnPipe.EcsEnvironmentFileProperty[]environment_filesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EcsEnvironmentFileProperty]]]environmentFilesoptionalIResolvableEnvironmentFilesoptionalIResolvableEnvironmentFilesoptionalinterface{}#
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
memoryoptionalnumbermemoryoptionalint | floatmemoryoptionalNumberMemoryoptionaldoubleMemoryoptional*float64#
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.

If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

memoryReservationoptionalnumbermemory_reservationoptionalint | floatmemoryReservationoptionalNumberMemoryReservationoptionaldoubleMemoryReservationoptional*float64#
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.

You must also specify a container name.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the container that receives the override.

This parameter is required if any override is specified.

resourceRequirementsoptionalIResolvable | IResolvable | CfnPipe.EcsResourceRequirementProperty[]resource_requirementsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EcsResourceRequirementProperty]]]resourceRequirementsoptionalIResolvableResourceRequirementsoptionalIResolvableResourceRequirementsoptionalinterface{}#
The type and amount of a resource to assign to a container, instead of the default value from the task definition.

The only supported resource is a GPU.