View a markdown version of this page

ClusterAutoPatchConfigDetails - Amazon SageMaker

ClusterAutoPatchConfigDetails

The auto-patching configuration details for the instance group, including the patching strategy and schedule.

Contents

CurrentPatchSchedule

The currently active patch schedule that the system will execute.

Type: ClusterPatchScheduleDetails object

Required: No

DeploymentConfig

The deployment configuration for rolling patch updates.

Type: DeploymentConfiguration object

Required: No

DesiredPatchSchedule

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

Type: ClusterPatchScheduleDetails object

Required: No

PatchingStrategy

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.

Type: String

Valid Values: WhenIdle | WhenAllIdle

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: