Skip to content

ContainerOverride

Source code in docs_src/capo_ecs/types/container_override.py
class ContainerOverride(TypedDict, closed=True):
    name: NotRequired["capo_ecs.types.string.String"]
    """<p>The name of the container that receives the override. This parameter is required if any override is specified.</p>"""
    command: NotRequired["capo_ecs.types.string_list.StringList"]
    """<p>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.</p>"""
    environment: NotRequired[
        "capo_ecs.types.environment_variables.EnvironmentVariables"
    ]
    """<p>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.</p>"""
    environment_files: NotRequired["capo_ecs.types.environment_files.EnvironmentFiles"]
    """<p>A list of files containing the environment variables to pass to a container, instead of the value from the container definition.</p>"""
    cpu: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>"""
    memory: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>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.</p>"""
    memory_reservation: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>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.</p>"""
    resource_requirements: NotRequired[
        "capo_ecs.types.resource_requirements.ResourceRequirements"
    ]
    """<p>The type and amount of a resource to assign to a container, instead of the default value from the task definition. The supported resources are GPUs and Neuron devices.</p>"""

command instance-attribute

command: NotRequired[StringList]

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.

cpu instance-attribute

cpu: NotRequired[BoxedInteger]

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.

environment instance-attribute

environment: NotRequired[EnvironmentVariables]

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.

environment_files instance-attribute

environment_files: NotRequired[EnvironmentFiles]

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

memory instance-attribute

memory: NotRequired[BoxedInteger]

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.

memory_reservation instance-attribute

memory_reservation: NotRequired[BoxedInteger]

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.

name instance-attribute

name: NotRequired[String]

The name of the container that receives the override. This parameter is required if any override is specified.

resource_requirements instance-attribute

resource_requirements: NotRequired[ResourceRequirements]

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The supported resources are GPUs and Neuron devices.