View a markdown version of this page

ClusterAutoPatchConfig - Amazon SageMaker

ClusterAutoPatchConfig

The configuration for automatic patching of the instance group. When configured, the system automatically applies security patch AMI updates to the instance group.

Contents

PatchingStrategy

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.

Type: String

Valid Values: WhenIdle | WhenAllIdle

Required: Yes

DeploymentConfig

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

Type: DeploymentConfiguration object

Required: No

PatchSchedule

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

Type: ClusterPatchSchedule object

Required: No

See Also

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