Module Values_2.UpdateClusterSoftwareRequestSource

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.

Sourcetype nonrec t = {
  1. clusterName : Values_0.ClusterNameOrArn.t;
    (*

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

    *)
  2. instanceGroups : UpdateClusterSoftwareInstanceGroups.t option;
    (*

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

    *)
  3. deploymentConfig : Values_0.DeploymentConfiguration.t option;
    (*

    The configuration to use when updating the AMI versions.

    *)
  4. imageId : Values_0.ImageId.t option;
    (*

    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.

    *)
}
Sourceval context_ : string
Sourceval make : ?instanceGroups:??? -> ?deploymentConfig:??? -> ?imageId:??? -> clusterName:Values_0.ClusterNameOrArn.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of Values_0.ClusterInstanceGroupName.t ]) list ] list | `String of Values_0.ClusterNameOrArn.t | `Structure of (string * [> `Integer of int | `List of [> `Structure of (string * [> `String of string ]) list ] list | `Structure of (string * [> `Structure of (string * [> `Enum of string | `Integer of int ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t