Skip to content

UpdateClusterRequest

Source code in docs_src/capo_sagemaker/types/update_cluster_request.py
class UpdateClusterRequest(TypedDict, closed=True):
    cluster_name: NotRequired[
        "capo_sagemaker.types.cluster_name_or_arn.ClusterNameOrArn"
    ]
    """<p>Specify the name of the SageMaker HyperPod cluster you want to update.</p>"""
    instance_groups: NotRequired[
        "capo_sagemaker.types.cluster_instance_group_specifications.ClusterInstanceGroupSpecifications"
    ]
    """<p>Specify the instance groups to update.</p>"""
    restricted_instance_groups: NotRequired[
        "capo_sagemaker.types.cluster_restricted_instance_group_specifications.ClusterRestrictedInstanceGroupSpecifications"
    ]
    """<p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>"""
    restricted_instance_groups_config: NotRequired[
        "capo_sagemaker.types.cluster_restricted_instance_groups_config.ClusterRestrictedInstanceGroupsConfig"
    ]
    """<p>The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.</p>"""
    tiered_storage_config: NotRequired[
        "capo_sagemaker.types.cluster_tiered_storage_config.ClusterTieredStorageConfig"
    ]
    """<p>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.</p>"""
    node_recovery: NotRequired[
        "capo_sagemaker.types.cluster_node_recovery.ClusterNodeRecovery"
    ]
    """<p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>"""
    instance_groups_to_delete: NotRequired[
        "capo_sagemaker.types.cluster_instance_groups_to_delete.ClusterInstanceGroupsToDelete"
    ]
    """<p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>"""
    node_provisioning_mode: NotRequired[
        "capo_sagemaker.types.cluster_node_provisioning_mode.ClusterNodeProvisioningMode"
    ]
    """<p>Determines how instance provisioning is handled during cluster operations. In <code>Continuous</code> 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 <code>CurrentCount</code> and <code>TargetCount</code> in <code>DescribeCluster</code> to track provisioning progress.</p>"""
    cluster_role: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.</p>"""
    auto_scaling: NotRequired[
        "capo_sagemaker.types.cluster_auto_scaling_config.ClusterAutoScalingConfig"
    ]
    """<p>Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.</p>"""
    orchestrator: NotRequired[
        "capo_sagemaker.types.cluster_orchestrator.ClusterOrchestrator"
    ]

auto_scaling instance-attribute

auto_scaling: NotRequired[ClusterAutoScalingConfig]

Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.

cluster_name instance-attribute

cluster_name: NotRequired[ClusterNameOrArn]

Specify the name of the SageMaker HyperPod cluster you want to update.

cluster_role instance-attribute

cluster_role: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.

instance_groups instance-attribute

instance_groups: NotRequired[ClusterInstanceGroupSpecifications]

Specify the instance groups to update.

instance_groups_to_delete instance-attribute

instance_groups_to_delete: NotRequired[ClusterInstanceGroupsToDelete]

Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.

node_provisioning_mode instance-attribute

node_provisioning_mode: NotRequired[ClusterNodeProvisioningMode]

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 DescribeCluster to track provisioning progress.

node_recovery instance-attribute

node_recovery: NotRequired[ClusterNodeRecovery]

The node recovery mode to be applied to the SageMaker HyperPod cluster.

orchestrator instance-attribute

orchestrator: NotRequired[ClusterOrchestrator]

restricted_instance_groups instance-attribute

restricted_instance_groups: NotRequired[ClusterRestrictedInstanceGroupSpecifications]

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

restricted_instance_groups_config instance-attribute

restricted_instance_groups_config: NotRequired[ClusterRestrictedInstanceGroupsConfig]

The configuration for the restricted instance groups (RIG) in the SageMaker HyperPod cluster.

tiered_storage_config instance-attribute

tiered_storage_config: NotRequired[ClusterTieredStorageConfig]

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.