Skip to content

AwsEcsTaskDefinitionDetails

Source code in docs_src/capo_securityhub/types/aws_ecs_task_definition_details.py
class AwsEcsTaskDefinitionDetails(TypedDict, closed=True):
    container_definitions: NotRequired[
        "capo_securityhub.types.aws_ecs_task_definition_container_definitions_list.AwsEcsTaskDefinitionContainerDefinitionsList"
    ]
    """<p>The container definitions that describe the containers that make up the task.</p>"""
    cpu: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The number of CPU units used by the task.Valid values are as follows:</p> <ul> <li> <p> <code>256 (.25 vCPU)</code> </p> </li> <li> <p> <code>512 (.5 vCPU)</code> </p> </li> <li> <p> <code>1024 (1 vCPU)</code> </p> </li> <li> <p> <code>2048 (2 vCPU)</code> </p> </li> <li> <p> <code>4096 (4 vCPU)</code> </p> </li> </ul>"""
    execution_role_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.</p>"""
    family: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of a family that this task definition is registered to.</p>"""
    inference_accelerators: NotRequired[
        "capo_securityhub.types.aws_ecs_task_definition_inference_accelerators_list.AwsEcsTaskDefinitionInferenceAcceleratorsList"
    ]
    """<p>The Elastic Inference accelerators to use for the containers in the task.</p>"""
    ipc_mode: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:</p> <ul> <li> <p> <code>host</code> </p> </li> <li> <p> <code>none</code> </p> </li> <li> <p> <code>task</code> </p> </li> </ul>"""
    memory: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The amount (in MiB) of memory used by the task. </p> <p>For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">specified values</a> in the <i> <i>Amazon Elastic Container Service Developer Guide</i> </i>, which determines your range of supported values for the <code>Cpu</code> and <code>Memory</code> parameters.</p>"""
    network_mode: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The Docker networking mode to use for the containers in the task. Valid values are as follows:</p> <ul> <li> <p> <code>awsvpc</code> </p> </li> <li> <p> <code>bridge</code> </p> </li> <li> <p> <code>host</code> </p> </li> <li> <p> <code>none</code> </p> </li> </ul>"""
    pid_mode: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The process namespace to use for the containers in the task. Valid values are <code>host</code> or <code>task</code>.</p>"""
    placement_constraints: NotRequired[
        "capo_securityhub.types.aws_ecs_task_definition_placement_constraints_list.AwsEcsTaskDefinitionPlacementConstraintsList"
    ]
    """<p>The placement constraint objects to use for tasks.</p>"""
    proxy_configuration: NotRequired[
        "capo_securityhub.types.aws_ecs_task_definition_proxy_configuration_details.AwsEcsTaskDefinitionProxyConfigurationDetails"
    ]
    """<p>The configuration details for the App Mesh proxy.</p>"""
    requires_compatibilities: NotRequired[
        "capo_securityhub.types.non_empty_string_list.NonEmptyStringList"
    ]
    """<p>The task launch types that the task definition was validated against.</p>"""
    task_role_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.</p>"""
    volumes: NotRequired[
        "capo_securityhub.types.aws_ecs_task_definition_volumes_list.AwsEcsTaskDefinitionVolumesList"
    ]
    """<p>The data volume definitions for the task.</p>"""
    status: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The status of the task definition. </p>"""

container_definitions instance-attribute

container_definitions: NotRequired[AwsEcsTaskDefinitionContainerDefinitionsList]

The container definitions that describe the containers that make up the task.

cpu instance-attribute

cpu: NotRequired[NonEmptyString]

The number of CPU units used by the task.Valid values are as follows:

  • 256 (.25 vCPU)

  • 512 (.5 vCPU)

  • 1024 (1 vCPU)

  • 2048 (2 vCPU)

  • 4096 (4 vCPU)

execution_role_arn instance-attribute

execution_role_arn: NotRequired[NonEmptyString]

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

family instance-attribute

family: NotRequired[NonEmptyString]

The name of a family that this task definition is registered to.

inference_accelerators instance-attribute

inference_accelerators: NotRequired[AwsEcsTaskDefinitionInferenceAcceleratorsList]

The Elastic Inference accelerators to use for the containers in the task.

ipc_mode instance-attribute

ipc_mode: NotRequired[NonEmptyString]

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

  • host

  • none

  • task

memory instance-attribute

memory: NotRequired[NonEmptyString]

The amount (in MiB) of memory used by the task.

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.

network_mode instance-attribute

network_mode: NotRequired[NonEmptyString]

The Docker networking mode to use for the containers in the task. Valid values are as follows:

  • awsvpc

  • bridge

  • host

  • none

pid_mode instance-attribute

pid_mode: NotRequired[NonEmptyString]

The process namespace to use for the containers in the task. Valid values are host or task.

placement_constraints instance-attribute

placement_constraints: NotRequired[AwsEcsTaskDefinitionPlacementConstraintsList]

The placement constraint objects to use for tasks.

proxy_configuration instance-attribute

proxy_configuration: NotRequired[AwsEcsTaskDefinitionProxyConfigurationDetails]

The configuration details for the App Mesh proxy.

requires_compatibilities instance-attribute

requires_compatibilities: NotRequired[NonEmptyStringList]

The task launch types that the task definition was validated against.

status instance-attribute

status: NotRequired[NonEmptyString]

The status of the task definition.

task_role_arn instance-attribute

task_role_arn: NotRequired[NonEmptyString]

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

volumes instance-attribute

volumes: NotRequired[AwsEcsTaskDefinitionVolumesList]

The data volume definitions for the task.