InstanceRefresh ¶

class InstanceRefresh(TypedDict, closed=True):
    instance_refresh_id: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The instance refresh ID.</p>"""
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group.</p>"""
    status: NotRequired[
        "capo_auto_scaling.types.instance_refresh_status.InstanceRefreshStatus"
    ]
    """<p>The current status for the instance refresh operation:</p> <ul> <li> <p> <code>Pending</code> - The request was created, but the instance refresh has not started.</p> </li> <li> <p> <code>InProgress</code> - An instance refresh is in progress.</p> </li> <li> <p> <code>Successful</code> - An instance refresh completed successfully.</p> </li> <li> <p> <code>Failed</code> - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities. </p> </li> <li> <p> <code>Cancelling</code> - An ongoing instance refresh is being cancelled.</p> </li> <li> <p> <code>Cancelled</code> - The instance refresh is cancelled. </p> </li> <li> <p> <code>RollbackInProgress</code> - An instance refresh is being rolled back.</p> </li> <li> <p> <code>RollbackFailed</code> - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.</p> </li> <li> <p> <code>RollbackSuccessful</code> - The rollback completed successfully.</p> </li> <li> <p> <code>Baking</code> - Waiting the specified bake time after an instance refresh has finished updating instances.</p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len1023.XmlStringMaxLen1023"
    ]
    """<p>The explanation for the specific status assigned to this operation.</p>"""
    start_time: NotRequired["capo_auto_scaling.types.timestamp_type.TimestampType"]
    """<p>The date and time at which the instance refresh began.</p>"""
    end_time: NotRequired["capo_auto_scaling.types.timestamp_type.TimestampType"]
    """<p>The date and time at which the instance refresh ended.</p>"""
    percentage_complete: NotRequired["capo_auto_scaling.types.int_percent.IntPercent"]
    """<p>The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.</p> <note> <p> <code>PercentageComplete</code> does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.</p> </note>"""
    instances_to_update: NotRequired[
        "capo_auto_scaling.types.instances_to_update.InstancesToUpdate"
    ]
    """<p>The number of instances remaining to update before the instance refresh is complete.</p> <note> <p>If you roll back the instance refresh, <code>InstancesToUpdate</code> shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.</p> </note>"""
    progress_details: NotRequired[
        "capo_auto_scaling.types.instance_refresh_progress_details.InstanceRefreshProgressDetails"
    ]
    """<p>Additional progress details for an Auto Scaling group that has a warm pool.</p>"""
    preferences: NotRequired[
        "capo_auto_scaling.types.refresh_preferences.RefreshPreferences"
    ]
    """<p>The preferences for an instance refresh.</p>"""
    desired_configuration: NotRequired[
        "capo_auto_scaling.types.desired_configuration.DesiredConfiguration"
    ]
    """<p>Describes the desired configuration for the instance refresh.</p>"""
    rollback_details: NotRequired[
        "capo_auto_scaling.types.rollback_details.RollbackDetails"
    ]
    """<p>The rollback details.</p>"""
    strategy: NotRequired["capo_auto_scaling.types.refresh_strategy.RefreshStrategy"]
    """<p> The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are updated. Default is Rolling. </p> <ul> <li> <p> <code>Rolling</code> – Terminates instances and launches replacements in batches</p> </li> <li> <p> <code>ReplaceRootVolume</code> – Updates instances by replacing only the root volume without terminating the instance</p> </li> </ul>"""