Update Cluster Software

sagemaker_update_cluster_software

R Documentation

Updates the platform software of a SageMaker HyperPod cluster for security patching

Description

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.

The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.

Usage

sagemaker_update_cluster_software(ClusterName, InstanceGroups,
  DeploymentConfig)

Arguments

ClusterName	[required] Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
InstanceGroups	The array of instance groups for which to update AMI versions.
DeploymentConfig	The configuration to use when updating the AMI versions.

Value

A list with the following syntax:

list(
  ClusterArn = "string"
)

Request syntax

svc$update_cluster_software(
  ClusterName = "string",
  InstanceGroups = list(
    list(
      InstanceGroupName = "string"
    )
  ),
  DeploymentConfig = list(
    RollingUpdatePolicy = list(
      MaximumBatchSize = list(
        Type = "INSTANCE_COUNT"|"CAPACITY_PERCENTAGE",
        Value = 123
      ),
      RollbackMaximumBatchSize = list(
        Type = "INSTANCE_COUNT"|"CAPACITY_PERCENTAGE",
        Value = 123
      )
    ),
    WaitIntervalInSeconds = 123,
    AutoRollbackConfiguration = list(
      list(
        AlarmName = "string"
      )
    )
  )
)