Skip to content

DaemonContainerDefinition

Source code in docs_src/capo_ecs/types/daemon_container_definition.py
class DaemonContainerDefinition(TypedDict, closed=True):
    name: NotRequired["capo_ecs.types.string.String"]
    """<p>The name of the container. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.</p>"""
    image: "capo_ecs.types.string.String"
    """<p>The image used to start the 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 <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>.</p>"""
    memory: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is killed.</p>"""
    memory_reservation: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>The soft limit (in MiB) of memory to reserve for the container.</p>"""
    repository_credentials: NotRequired[
        "capo_ecs.types.repository_credentials.RepositoryCredentials"
    ]
    """<p>The private repository authentication credentials to use.</p>"""
    health_check: NotRequired["capo_ecs.types.health_check.HealthCheck"]
    """<p>The container health check command and associated configuration parameters for the container.</p>"""
    cpu: "capo_ecs.types.integer.Integer"
    """<p>The number of <code>cpu</code> units reserved for the container.</p>"""
    essential: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>If the <code>essential</code> parameter of a container is marked as <code>true</code>, and that container fails or stops for any reason, all other containers that are part of the task are stopped.</p>"""
    entry_point: NotRequired["capo_ecs.types.string_list.StringList"]
    """<p>The entry point that's passed to the container.</p>"""
    command: NotRequired["capo_ecs.types.string_list.StringList"]
    """<p>The command that's passed to the container.</p>"""
    working_directory: NotRequired["capo_ecs.types.string.String"]
    """<p>The working directory to run commands inside the container in.</p>"""
    environment_files: NotRequired["capo_ecs.types.environment_files.EnvironmentFiles"]
    """<p>A list of files containing the environment variables to pass to a container.</p>"""
    environment: NotRequired[
        "capo_ecs.types.environment_variables.EnvironmentVariables"
    ]
    """<p>The environment variables to pass to a container.</p>"""
    secrets: NotRequired["capo_ecs.types.secret_list.SecretList"]
    """<p>The secrets to pass to the container.</p>"""
    readonly_root_filesystem: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>When this parameter is true, the container is given read-only access to its root file system.</p>"""
    mount_points: NotRequired["capo_ecs.types.mount_point_list.MountPointList"]
    """<p>The mount points for data volumes in your container.</p>"""
    log_configuration: NotRequired["capo_ecs.types.log_configuration.LogConfiguration"]
    """<p>The log configuration specification for the container.</p>"""
    firelens_configuration: NotRequired[
        "capo_ecs.types.firelens_configuration.FirelensConfiguration"
    ]
    """<p>The FireLens configuration for the container. This is used to specify and configure a log router for container logs.</p>"""
    privileged: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user).</p>"""
    user: NotRequired["capo_ecs.types.string.String"]
    """<p>The user to use inside the container.</p>"""
    ulimits: NotRequired["capo_ecs.types.ulimit_list.UlimitList"]
    """<p>A list of <code>ulimits</code> to set in the container.</p>"""
    linux_parameters: NotRequired[
        "capo_ecs.types.daemon_linux_parameters.DaemonLinuxParameters"
    ]
    """<p>Linux-specific modifications that are applied to the container configuration, such as Linux kernel capabilities.</p>"""
    depends_on: NotRequired[
        "capo_ecs.types.container_dependencies.ContainerDependencies"
    ]
    """<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition.</p>"""
    start_timeout: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>Time duration (in seconds) to wait before giving up on resolving dependencies for a container.</p>"""
    stop_timeout: NotRequired["capo_ecs.types.boxed_integer.BoxedInteger"]
    """<p>Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.</p>"""
    system_controls: NotRequired["capo_ecs.types.system_controls.SystemControls"]
    """<p>A list of namespaced kernel parameters to set in the container.</p>"""
    interactive: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>When this parameter is <code>true</code>, you can deploy containerized applications that require <code>stdin</code> or a <code>tty</code> to be allocated.</p>"""
    pseudo_terminal: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>When this parameter is <code>true</code>, a TTY is allocated.</p>"""
    restart_policy: NotRequired[
        "capo_ecs.types.container_restart_policy.ContainerRestartPolicy"
    ]
    """<p>The restart policy for the container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.</p>"""

command instance-attribute

command: NotRequired[StringList]

The command that's passed to the container.

cpu instance-attribute

cpu: Integer

The number of cpu units reserved for the container.

depends_on instance-attribute

depends_on: NotRequired[ContainerDependencies]

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies on other containers in a task definition.

entry_point instance-attribute

entry_point: NotRequired[StringList]

The entry point that's passed to the container.

environment instance-attribute

environment: NotRequired[EnvironmentVariables]

The environment variables to pass to a container.

environment_files instance-attribute

environment_files: NotRequired[EnvironmentFiles]

A list of files containing the environment variables to pass to a container.

essential instance-attribute

essential: NotRequired[BoxedBoolean]

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.

firelens_configuration instance-attribute

firelens_configuration: NotRequired[FirelensConfiguration]

The FireLens configuration for the container. This is used to specify and configure a log router for container logs.

health_check instance-attribute

health_check: NotRequired[HealthCheck]

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

image instance-attribute

image: String

The image used to start the 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 .

interactive instance-attribute

interactive: NotRequired[BoxedBoolean]

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated.

linux_parameters instance-attribute

linux_parameters: NotRequired[DaemonLinuxParameters]

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

log_configuration instance-attribute

log_configuration: NotRequired[LogConfiguration]

The log configuration specification for the container.

memory instance-attribute

memory: NotRequired[BoxedInteger]

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is killed.

memory_reservation instance-attribute

memory_reservation: NotRequired[BoxedInteger]

The soft limit (in MiB) of memory to reserve for the container.

mount_points instance-attribute

mount_points: NotRequired[MountPointList]

The mount points for data volumes in your container.

name instance-attribute

name: NotRequired[String]

The name of the container. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

privileged instance-attribute

privileged: NotRequired[BoxedBoolean]

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

pseudo_terminal instance-attribute

pseudo_terminal: NotRequired[BoxedBoolean]

When this parameter is true, a TTY is allocated.

readonly_root_filesystem instance-attribute

readonly_root_filesystem: NotRequired[BoxedBoolean]

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

repository_credentials instance-attribute

repository_credentials: NotRequired[RepositoryCredentials]

The private repository authentication credentials to use.

restart_policy instance-attribute

restart_policy: NotRequired[ContainerRestartPolicy]

The restart policy for the container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.

secrets instance-attribute

secrets: NotRequired[SecretList]

The secrets to pass to the container.

start_timeout instance-attribute

start_timeout: NotRequired[BoxedInteger]

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

stop_timeout instance-attribute

stop_timeout: NotRequired[BoxedInteger]

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

system_controls instance-attribute

system_controls: NotRequired[SystemControls]

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

ulimits instance-attribute

ulimits: NotRequired[UlimitList]

A list of ulimits to set in the container.

user instance-attribute

user: NotRequired[String]

The user to use inside the container.

working_directory instance-attribute

working_directory: NotRequired[String]

The working directory to run commands inside the container in.