Skip to content

ECSTaskSet

Source code in docs_src/capo_codedeploy/types/ecs_task_set.py
class ECSTaskSet(TypedDict, closed=True):
    identifer: NotRequired[
        "capo_codedeploy.types.ecs_task_set_identifier.ECSTaskSetIdentifier"
    ]
    """<p> A unique ID of an <code>ECSTaskSet</code>. </p>"""
    desired_count: "capo_codedeploy.types.ecs_task_set_count.ECSTaskSetCount"
    """<p> The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. </p>"""
    pending_count: "capo_codedeploy.types.ecs_task_set_count.ECSTaskSetCount"
    """<p> The number of tasks in the task set that are in the <code>PENDING</code> status during an Amazon ECS deployment. A task in the <code>PENDING</code> state is preparing to enter the <code>RUNNING</code> state. A task set enters the <code>PENDING</code> status when it launches for the first time, or when it is restarted after being in the <code>STOPPED</code> state. </p>"""
    running_count: "capo_codedeploy.types.ecs_task_set_count.ECSTaskSetCount"
    """<p> The number of tasks in the task set that are in the <code>RUNNING</code> status during an Amazon ECS deployment. A task in the <code>RUNNING</code> state is running and ready for use. </p>"""
    status: NotRequired["capo_codedeploy.types.ecs_task_set_status.ECSTaskSetStatus"]
    """<p> The status of the task set. There are three valid task set statuses: </p> <ul> <li> <p> <code>PRIMARY</code>: Indicates the task set is serving production traffic. </p> </li> <li> <p> <code>ACTIVE</code>: Indicates the task set is not serving production traffic. </p> </li> <li> <p> <code>DRAINING</code>: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. </p> </li> </ul>"""
    traffic_weight: "capo_codedeploy.types.traffic_weight.TrafficWeight"
    """<p> The percentage of traffic served by this task set. </p>"""
    target_group: NotRequired["capo_codedeploy.types.target_group_info.TargetGroupInfo"]
    """<p> The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set. </p>"""
    task_set_label: NotRequired["capo_codedeploy.types.target_label.TargetLabel"]
    """<p> A label that identifies whether the ECS task set is an original target (<code>BLUE</code>) or a replacement target (<code>GREEN</code>). </p>"""

desired_count instance-attribute

desired_count: ECSTaskSetCount

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

identifer instance-attribute

identifer: NotRequired[ECSTaskSetIdentifier]

A unique ID of an ECSTaskSet.

pending_count instance-attribute

pending_count: ECSTaskSetCount

The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

running_count instance-attribute

running_count: ECSTaskSetCount

The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

status instance-attribute

status: NotRequired[ECSTaskSetStatus]

The status of the task set. There are three valid task set statuses:

  • PRIMARY: Indicates the task set is serving production traffic.

  • ACTIVE: Indicates the task set is not serving production traffic.

  • DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

target_group instance-attribute

target_group: NotRequired[TargetGroupInfo]

The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

task_set_label instance-attribute

task_set_label: NotRequired[TargetLabel]

A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

traffic_weight instance-attribute

traffic_weight: TrafficWeight

The percentage of traffic served by this task set.