Update Cluster

sagemaker_update_cluster

R Documentation

Updates a SageMaker HyperPod cluster

Description

Updates a SageMaker HyperPod cluster.

Usage

sagemaker_update_cluster(ClusterName, InstanceGroups,
  RestrictedInstanceGroups, RestrictedInstanceGroupsConfig,
  TieredStorageConfig, NodeRecovery, InstanceGroupsToDelete,
  NodeProvisioningMode, ClusterRole, AutoScaling, Orchestrator)

Arguments

ClusterName	[required] Specify the name of the SageMaker HyperPod cluster you want to update.
InstanceGroups	Specify the instance groups to update.
RestrictedInstanceGroups	The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
RestrictedInstanceGroupsConfig	The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.
TieredStorageConfig	Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.
NodeRecovery	The node recovery mode to be applied to the SageMaker HyperPod cluster.
InstanceGroupsToDelete	Specify the names of the instance groups to delete. Use a single ⁠,⁠ as the separator between multiple names.
NodeProvisioningMode	Determines how instance provisioning is handled during cluster operations. In Continuous mode, the cluster provisions available instances incrementally and retries until the target count is reached. The cluster becomes operational once cluster-level resources are ready. Use CurrentCount and TargetCount in describe_cluster to track provisioning progress.
ClusterRole	The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.
AutoScaling	Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.
Orchestrator	The type of orchestrator used for the SageMaker HyperPod cluster.

Value

A list with the following syntax:

list(
  ClusterArn = "string"
)

Request syntax

svc$update_cluster(
  ClusterName = "string",
  InstanceGroups = list(
    list(
      InstanceCount = 123,
      MinInstanceCount = 123,
      InstanceGroupName = "string",
      InstanceType = "ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.p5.4xlarge"|"ml.p6e-gb200.36xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.12xlarge"|"ml.g5.16xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.c5n.large"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.16xlarge"|"ml.g6.12xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.gr6.4xlarge"|"ml.gr6.8xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.16xlarge"|"ml.g6e.12xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.p6-b200.48xlarge"|"ml.trn2.3xlarge"|"ml.trn2.48xlarge"|"ml.c6i.large"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.4xlarge"|"ml.c6i.8xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.r6i.large"|"ml.r6i.xlarge"|"ml.r6i.2xlarge"|"ml.r6i.4xlarge"|"ml.r6i.8xlarge"|"ml.r6i.12xlarge"|"ml.r6i.16xlarge"|"ml.r6i.24xlarge"|"ml.r6i.32xlarge"|"ml.i3en.large"|"ml.i3en.xlarge"|"ml.i3en.2xlarge"|"ml.i3en.3xlarge"|"ml.i3en.6xlarge"|"ml.i3en.12xlarge"|"ml.i3en.24xlarge"|"ml.m7i.large"|"ml.m7i.xlarge"|"ml.m7i.2xlarge"|"ml.m7i.4xlarge"|"ml.m7i.8xlarge"|"ml.m7i.12xlarge"|"ml.m7i.16xlarge"|"ml.m7i.24xlarge"|"ml.m7i.48xlarge"|"ml.r7i.large"|"ml.r7i.xlarge"|"ml.r7i.2xlarge"|"ml.r7i.4xlarge"|"ml.r7i.8xlarge"|"ml.r7i.12xlarge"|"ml.r7i.16xlarge"|"ml.r7i.24xlarge"|"ml.r7i.48xlarge"|"ml.r5d.16xlarge"|"ml.g7e.2xlarge"|"ml.g7e.4xlarge"|"ml.g7e.8xlarge"|"ml.g7e.12xlarge"|"ml.g7e.24xlarge"|"ml.g7e.48xlarge"|"ml.p6-b300.48xlarge",
      InstanceRequirements = list(
        InstanceTypes = list(
          "ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.p5.4xlarge"|"ml.p6e-gb200.36xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.12xlarge"|"ml.g5.16xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.c5n.large"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.16xlarge"|"ml.g6.12xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.gr6.4xlarge"|"ml.gr6.8xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.16xlarge"|"ml.g6e.12xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.p6-b200.48xlarge"|"ml.trn2.3xlarge"|"ml.trn2.48xlarge"|"ml.c6i.large"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.4xlarge"|"ml.c6i.8xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.r6i.large"|"ml.r6i.xlarge"|"ml.r6i.2xlarge"|"ml.r6i.4xlarge"|"ml.r6i.8xlarge"|"ml.r6i.12xlarge"|"ml.r6i.16xlarge"|"ml.r6i.24xlarge"|"ml.r6i.32xlarge"|"ml.i3en.large"|"ml.i3en.xlarge"|"ml.i3en.2xlarge"|"ml.i3en.3xlarge"|"ml.i3en.6xlarge"|"ml.i3en.12xlarge"|"ml.i3en.24xlarge"|"ml.m7i.large"|"ml.m7i.xlarge"|"ml.m7i.2xlarge"|"ml.m7i.4xlarge"|"ml.m7i.8xlarge"|"ml.m7i.12xlarge"|"ml.m7i.16xlarge"|"ml.m7i.24xlarge"|"ml.m7i.48xlarge"|"ml.r7i.large"|"ml.r7i.xlarge"|"ml.r7i.2xlarge"|"ml.r7i.4xlarge"|"ml.r7i.8xlarge"|"ml.r7i.12xlarge"|"ml.r7i.16xlarge"|"ml.r7i.24xlarge"|"ml.r7i.48xlarge"|"ml.r5d.16xlarge"|"ml.g7e.2xlarge"|"ml.g7e.4xlarge"|"ml.g7e.8xlarge"|"ml.g7e.12xlarge"|"ml.g7e.24xlarge"|"ml.g7e.48xlarge"|"ml.p6-b300.48xlarge"
        )
      ),
      LifeCycleConfig = list(
        SourceS3Uri = "string",
        OnCreate = "string",
        OnInitComplete = "string"
      ),
      ExecutionRole = "string",
      ThreadsPerCore = 123,
      InstanceStorageConfigs = list(
        list(
          EbsVolumeConfig = list(
            VolumeSizeInGB = 123,
            VolumeKmsKeyId = "string",
            RootVolume = TRUE|FALSE
          ),
          FsxLustreConfig = list(
            DnsName = "string",
            MountName = "string",
            MountPath = "string"
          ),
          FsxOpenZfsConfig = list(
            DnsName = "string",
            MountPath = "string"
          )
        )
      ),
      OnStartDeepHealthChecks = list(
        "InstanceStress"|"InstanceConnectivity"
      ),
      TrainingPlanArn = "string",
      OverrideVpcConfig = list(
        SecurityGroupIds = list(
          "string"
        ),
        Subnets = list(
          "string"
        )
      ),
      ScheduledUpdateConfig = list(
        ScheduleExpression = "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"
            )
          )
        )
      ),
      ImageId = "string",
      KubernetesConfig = list(
        Labels = list(
          "string"
        ),
        Taints = list(
          list(
            Key = "string",
            Value = "string",
            Effect = "NoSchedule"|"PreferNoSchedule"|"NoExecute"
          )
        )
      ),
      SlurmConfig = list(
        NodeType = "Controller"|"Login"|"Compute",
        PartitionNames = list(
          "string"
        )
      ),
      CapacityRequirements = list(
        Spot = list(),
        OnDemand = list()
      ),
      NetworkInterface = list(
        InterfaceType = "efa"|"efa-only"
      )
    )
  ),
  RestrictedInstanceGroups = list(
    list(
      InstanceCount = 123,
      InstanceGroupName = "string",
      InstanceType = "ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.p5.4xlarge"|"ml.p6e-gb200.36xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.12xlarge"|"ml.g5.16xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.c5n.large"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.16xlarge"|"ml.g6.12xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.gr6.4xlarge"|"ml.gr6.8xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.16xlarge"|"ml.g6e.12xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.p6-b200.48xlarge"|"ml.trn2.3xlarge"|"ml.trn2.48xlarge"|"ml.c6i.large"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.4xlarge"|"ml.c6i.8xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.r6i.large"|"ml.r6i.xlarge"|"ml.r6i.2xlarge"|"ml.r6i.4xlarge"|"ml.r6i.8xlarge"|"ml.r6i.12xlarge"|"ml.r6i.16xlarge"|"ml.r6i.24xlarge"|"ml.r6i.32xlarge"|"ml.i3en.large"|"ml.i3en.xlarge"|"ml.i3en.2xlarge"|"ml.i3en.3xlarge"|"ml.i3en.6xlarge"|"ml.i3en.12xlarge"|"ml.i3en.24xlarge"|"ml.m7i.large"|"ml.m7i.xlarge"|"ml.m7i.2xlarge"|"ml.m7i.4xlarge"|"ml.m7i.8xlarge"|"ml.m7i.12xlarge"|"ml.m7i.16xlarge"|"ml.m7i.24xlarge"|"ml.m7i.48xlarge"|"ml.r7i.large"|"ml.r7i.xlarge"|"ml.r7i.2xlarge"|"ml.r7i.4xlarge"|"ml.r7i.8xlarge"|"ml.r7i.12xlarge"|"ml.r7i.16xlarge"|"ml.r7i.24xlarge"|"ml.r7i.48xlarge"|"ml.r5d.16xlarge"|"ml.g7e.2xlarge"|"ml.g7e.4xlarge"|"ml.g7e.8xlarge"|"ml.g7e.12xlarge"|"ml.g7e.24xlarge"|"ml.g7e.48xlarge"|"ml.p6-b300.48xlarge",
      ExecutionRole = "string",
      ThreadsPerCore = 123,
      InstanceStorageConfigs = list(
        list(
          EbsVolumeConfig = list(
            VolumeSizeInGB = 123,
            VolumeKmsKeyId = "string",
            RootVolume = TRUE|FALSE
          ),
          FsxLustreConfig = list(
            DnsName = "string",
            MountName = "string",
            MountPath = "string"
          ),
          FsxOpenZfsConfig = list(
            DnsName = "string",
            MountPath = "string"
          )
        )
      ),
      OnStartDeepHealthChecks = list(
        "InstanceStress"|"InstanceConnectivity"
      ),
      TrainingPlanArn = "string",
      OverrideVpcConfig = list(
        SecurityGroupIds = list(
          "string"
        ),
        Subnets = list(
          "string"
        )
      ),
      ScheduledUpdateConfig = list(
        ScheduleExpression = "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"
            )
          )
        )
      ),
      EnvironmentConfig = list(
        FSxLustreConfig = list(
          SizeInGiB = 123,
          PerUnitStorageThroughput = 123
        )
      )
    )
  ),
  RestrictedInstanceGroupsConfig = list(
    SharedEnvironmentConfig = list(
      FSxLustreDeletionPolicy = "DeleteIfNotUsed"|"Keep",
      FSxLustreConfig = list(
        SizeInGiB = 123,
        PerUnitStorageThroughput = 123
      )
    )
  ),
  TieredStorageConfig = list(
    Mode = "Enable"|"Disable",
    InstanceMemoryAllocationPercentage = 123
  ),
  NodeRecovery = "Automatic"|"None",
  InstanceGroupsToDelete = list(
    "string"
  ),
  NodeProvisioningMode = "Continuous",
  ClusterRole = "string",
  AutoScaling = list(
    Mode = "Enable"|"Disable",
    AutoScalerType = "Karpenter"
  ),
  Orchestrator = list(
    Eks = list(
      ClusterArn = "string"
    ),
    Slurm = list(
      SlurmConfigStrategy = "Overwrite"|"Managed"|"Merge"
    )
  )
)