AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateClusterSoftware operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.UpdateClusterSoftwareRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C# 
public class UpdateClusterSoftwareRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The UpdateClusterSoftwareRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateClusterSoftwareRequest()

Properties

NameTypeDescription
Public Property ClusterName System.String

Gets and sets the property ClusterName.

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

Public Property DeploymentConfig Amazon.SageMaker.Model.DeploymentConfiguration

Gets and sets the property DeploymentConfig.

The configuration to use when updating the AMI versions.

Public Property ImageId System.String

Gets and sets the property ImageId.

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

Public Property InstanceGroups System.Collections.Generic.List<Amazon.SageMaker.Model.UpdateClusterSoftwareInstanceGroupSpecification>

Gets and sets the property InstanceGroups.

The array of instance groups for which to update AMI versions.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5