Skip to content

EksContainerOverride

Source code in docs_src/capo_batch/types/eks_container_override.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class EksContainerOverride(TypedDict, closed=True):
    name: NotRequired["capo_batch.types.string.String"]
    """<p>A pointer to the container that you want to override. The name must match a unique container name that you wish to override.</p>"""
    image: NotRequired["capo_batch.types.string.String"]
    """<p>The override of the Docker image that's used to start the container.</p>"""
    command: NotRequired["capo_batch.types.string_list.StringList"]
    """<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p>"""
    args: NotRequired["capo_batch.types.string_list.StringList"]
    """<p>The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference: CMD</a> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command an arguments for a pod</a> in the <i>Kubernetes documentation</i>.</p>"""
    env: NotRequired[
        "capo_batch.types.eks_container_environment_variables.EksContainerEnvironmentVariables"
    ]
    """<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 job definition.</p> <note> <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming convention is reserved for variables that Batch sets.</p> </note>"""
    resources: NotRequired[
        "capo_batch.types.eks_container_resource_requirements.EksContainerResourceRequirements"
    ]
    """<p>The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods and containers</a> in the <i>Kubernetes documentation</i>.</p>"""

args instance-attribute 

args: NotRequired[StringList]

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation.

command instance-attribute 

command: NotRequired[StringList]

The command to send to the container that overrides the default command from the Docker image or the job definition.

env instance-attribute 

env: NotRequired[EksContainerEnvironmentVariables]

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 job definition.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

image instance-attribute 

image: NotRequired[String]

The override of the Docker image that's used to start the container.

name instance-attribute 

name: NotRequired[String]

A pointer to the container that you want to override. The name must match a unique container name that you wish to override.

resources instance-attribute 

resources: NotRequired[EksContainerResourceRequirements]

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.