Skip to content

ClusterAutoPatchConfig

Source code in docs_src/capo_sagemaker/types/cluster_auto_patch_config.py
class ClusterAutoPatchConfig(TypedDict, closed=True):
    patching_strategy: (
        "capo_sagemaker.types.cluster_patching_strategy.ClusterPatchingStrategy"
    )
    """<p>The strategy 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>"""
    patch_schedule: NotRequired[
        "capo_sagemaker.types.cluster_patch_schedule.ClusterPatchSchedule"
    ]
    """<p>The schedule for automatic patching, including the next patch date.</p>"""
    deployment_config: NotRequired[
        "capo_sagemaker.types.deployment_configuration.DeploymentConfiguration"
    ]
    """<p>The deployment configuration for rolling patch updates, including rollback settings and batch sizes. Only applicable when using a rolling patching strategy.</p>"""

deployment_config instance-attribute

deployment_config: NotRequired[DeploymentConfiguration]

The deployment configuration for rolling patch updates, including rollback settings and batch sizes. Only applicable when using a rolling patching strategy.

patch_schedule instance-attribute

patch_schedule: NotRequired[ClusterPatchSchedule]

The schedule for automatic patching, including the next patch date.

patching_strategy instance-attribute

patching_strategy: ClusterPatchingStrategy

The strategy 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.