Skip to content

ClusterAutoPatchConfigDetails

Source code in docs_src/capo_sagemaker/types/cluster_auto_patch_config_details.py
class ClusterAutoPatchConfigDetails(TypedDict, closed=True):
    patching_strategy: NotRequired[
        "capo_sagemaker.types.cluster_patching_strategy.ClusterPatchingStrategy"
    ]
    """<p>The strategy used for applying patches to instances in the group.</p> <ul> <li> <p> <code>WhenIdle</code>: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.</p> </li> <li> <p> <code>WhenAllIdle</code>: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.</p> </li> </ul>"""
    current_patch_schedule: NotRequired[
        "capo_sagemaker.types.cluster_patch_schedule_details.ClusterPatchScheduleDetails"
    ]
    """<p>The currently active patch schedule that the system will execute.</p>"""
    desired_patch_schedule: NotRequired[
        "capo_sagemaker.types.cluster_patch_schedule_details.ClusterPatchScheduleDetails"
    ]
    """<p>The requested patch schedule. Differs from CurrentPatchSchedule when a reschedule request is pending.</p>"""
    deployment_config: NotRequired[
        "capo_sagemaker.types.deployment_configuration.DeploymentConfiguration"
    ]
    """<p>The deployment configuration for rolling patch updates.</p>"""

current_patch_schedule instance-attribute

current_patch_schedule: NotRequired[ClusterPatchScheduleDetails]

The currently active patch schedule that the system will execute.

deployment_config instance-attribute

deployment_config: NotRequired[DeploymentConfiguration]

The deployment configuration for rolling patch updates.

desired_patch_schedule instance-attribute

desired_patch_schedule: NotRequired[ClusterPatchScheduleDetails]

The requested patch schedule. Differs from CurrentPatchSchedule when a reschedule request is pending.

patching_strategy instance-attribute

patching_strategy: NotRequired[ClusterPatchingStrategy]

The strategy used for applying patches to instances in the group.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.