Skip to content

ReplaceRootVolumeTask

Source code in docs_src/capo_ec2/types/replace_root_volume_task.py
class ReplaceRootVolumeTask(TypedDict, closed=True):
    replace_root_volume_task_id: NotRequired[
        "capo_ec2.types.replace_root_volume_task_id.ReplaceRootVolumeTaskId"
    ]
    """<p>The ID of the root volume replacement task.</p>"""
    instance_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the instance for which the root volume replacement task was created.</p>"""
    task_state: NotRequired[
        "capo_ec2.types.replace_root_volume_task_state.ReplaceRootVolumeTaskState"
    ]
    """<p>The state of the task. The task can be in one of the following states:</p> <ul> <li> <p> <code>pending</code> - the replacement volume is being created.</p> </li> <li> <p> <code>in-progress</code> - the original volume is being detached and the replacement volume is being attached.</p> </li> <li> <p> <code>succeeded</code> - the replacement volume has been successfully attached to the instance and the instance is available.</p> </li> <li> <p> <code>failing</code> - the replacement task is in the process of failing.</p> </li> <li> <p> <code>failed</code> - the replacement task has failed but the original root volume is still attached.</p> </li> <li> <p> <code>failing-detached</code> - the replacement task is in the process of failing. The instance might have no root volume attached.</p> </li> <li> <p> <code>failed-detached</code> - the replacement task has failed and the instance has no root volume attached.</p> </li> </ul>"""
    start_time: NotRequired["capo_ec2.types.string.String"]
    """<p>The time the task was started.</p>"""
    complete_time: NotRequired["capo_ec2.types.string.String"]
    """<p>The time the task completed.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags assigned to the task.</p>"""
    image_id: NotRequired["capo_ec2.types.image_id.ImageId"]
    """<p>The ID of the AMI used to create the replacement root volume.</p>"""
    snapshot_id: NotRequired["capo_ec2.types.snapshot_id.SnapshotId"]
    """<p>The ID of the snapshot used to create the replacement root volume.</p>"""
    delete_replaced_root_volume: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the original root volume is to be deleted after the root volume replacement task completes.</p>"""

complete_time instance-attribute

complete_time: NotRequired[String]

The time the task completed.

delete_replaced_root_volume instance-attribute

delete_replaced_root_volume: NotRequired[Boolean]

Indicates whether the original root volume is to be deleted after the root volume replacement task completes.

image_id instance-attribute

image_id: NotRequired[ImageId]

The ID of the AMI used to create the replacement root volume.

instance_id instance-attribute

instance_id: NotRequired[String]

The ID of the instance for which the root volume replacement task was created.

replace_root_volume_task_id instance-attribute

replace_root_volume_task_id: NotRequired[ReplaceRootVolumeTaskId]

The ID of the root volume replacement task.

snapshot_id instance-attribute

snapshot_id: NotRequired[SnapshotId]

The ID of the snapshot used to create the replacement root volume.

start_time instance-attribute

start_time: NotRequired[String]

The time the task was started.

tags instance-attribute

tags: NotRequired[TagList]

The tags assigned to the task.

task_state instance-attribute

task_state: NotRequired[ReplaceRootVolumeTaskState]

The state of the task. The task can be in one of the following states:

  • pending - the replacement volume is being created.

  • in-progress - the original volume is being detached and the replacement volume is being attached.

  • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

  • failing - the replacement task is in the process of failing.

  • failed - the replacement task has failed but the original root volume is still attached.

  • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

  • failed-detached - the replacement task has failed and the instance has no root volume attached.