Skip to content

ClusterRestrictedInstanceGroupDetails

Source code in docs_src/capo_sagemaker/types/cluster_restricted_instance_group_details.py
class ClusterRestrictedInstanceGroupDetails(TypedDict, closed=True):
    current_count: NotRequired[
        "capo_sagemaker.types.cluster_non_negative_instance_count.ClusterNonNegativeInstanceCount"
    ]
    """<p>The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.</p>"""
    target_count: NotRequired[
        "capo_sagemaker.types.cluster_instance_count.ClusterInstanceCount"
    ]
    """<p>The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.</p>"""
    instance_group_name: NotRequired[
        "capo_sagemaker.types.cluster_instance_group_name.ClusterInstanceGroupName"
    ]
    """<p>The name of the restricted instance group of a SageMaker HyperPod cluster.</p>"""
    instance_type: NotRequired[
        "capo_sagemaker.types.cluster_instance_type.ClusterInstanceType"
    ]
    """<p>The instance type of the restricted instance group of a SageMaker HyperPod cluster.</p>"""
    execution_role: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The execution role for the restricted instance group to assume.</p>"""
    threads_per_core: NotRequired[
        "capo_sagemaker.types.cluster_threads_per_core.ClusterThreadsPerCore"
    ]
    """<p>The number you specified to <code>TreadsPerCore</code> in <code>CreateCluster</code> for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html">CPU cores and threads per CPU core per instance type</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"""
    instance_storage_configs: NotRequired[
        "capo_sagemaker.types.cluster_instance_storage_configs.ClusterInstanceStorageConfigs"
    ]
    """<p>The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.</p>"""
    on_start_deep_health_checks: NotRequired[
        "capo_sagemaker.types.on_start_deep_health_checks.OnStartDeepHealthChecks"
    ]
    """<p>A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.</p>"""
    status: NotRequired[
        "capo_sagemaker.types.instance_group_status.InstanceGroupStatus"
    ]
    """<p>The current status of the cluster's restricted instance group.</p> <ul> <li> <p> <code>InService</code>: The restricted instance group is active and healthy.</p> </li> <li> <p> <code>Creating</code>: The restricted instance group is being provisioned.</p> </li> <li> <p> <code>Updating</code>: The restricted instance group is being updated.</p> </li> <li> <p> <code>Failed</code>: The restricted instance group has failed to provision or is no longer healthy.</p> </li> <li> <p> <code>Degraded</code>: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.</p> </li> <li> <p> <code>Deleting</code>: The restricted instance group is being deleted.</p> </li> </ul>"""
    training_plan_arn: NotRequired[
        "capo_sagemaker.types.training_plan_arn.TrainingPlanArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html">CreateTrainingPlan</a> </code>.</p>"""
    training_plan_status: NotRequired[
        "capo_sagemaker.types.instance_group_training_plan_status.InstanceGroupTrainingPlanStatus"
    ]
    """<p>The current status of the training plan associated with this cluster restricted instance group.</p>"""
    override_vpc_config: NotRequired["capo_sagemaker.types.vpc_config.VpcConfig"]
    scheduled_update_config: NotRequired[
        "capo_sagemaker.types.scheduled_update_config.ScheduledUpdateConfig"
    ]
    environment_config: NotRequired[
        "capo_sagemaker.types.environment_config_details.EnvironmentConfigDetails"
    ]
    """<p>The configuration for the restricted instance groups (RIG) environment.</p>"""

current_count instance-attribute

current_count: NotRequired[ClusterNonNegativeInstanceCount]

The number of instances that are currently in the restricted instance group of a SageMaker HyperPod cluster.

environment_config instance-attribute

environment_config: NotRequired[EnvironmentConfigDetails]

The configuration for the restricted instance groups (RIG) environment.

execution_role instance-attribute

execution_role: NotRequired[RoleArn]

The execution role for the restricted instance group to assume.

instance_group_name instance-attribute

instance_group_name: NotRequired[ClusterInstanceGroupName]

The name of the restricted instance group of a SageMaker HyperPod cluster.

instance_storage_configs instance-attribute

instance_storage_configs: NotRequired[ClusterInstanceStorageConfigs]

The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted instance group.

instance_type instance-attribute

instance_type: NotRequired[ClusterInstanceType]

The instance type of the restricted instance group of a SageMaker HyperPod cluster.

on_start_deep_health_checks instance-attribute

on_start_deep_health_checks: NotRequired[OnStartDeepHealthChecks]

A flag indicating whether deep health checks should be performed when the cluster's restricted instance group is created or updated.

override_vpc_config instance-attribute

override_vpc_config: NotRequired[VpcConfig]

scheduled_update_config instance-attribute

scheduled_update_config: NotRequired[ScheduledUpdateConfig]

status instance-attribute

status: NotRequired[InstanceGroupStatus]

The current status of the cluster's restricted instance group.

  • InService: The restricted instance group is active and healthy.

  • Creating: The restricted instance group is being provisioned.

  • Updating: The restricted instance group is being updated.

  • Failed: The restricted instance group has failed to provision or is no longer healthy.

  • Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The restricted instance group is being deleted.

target_count instance-attribute

target_count: NotRequired[ClusterInstanceCount]

The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.

threads_per_core instance-attribute

threads_per_core: NotRequired[ClusterThreadsPerCore]

The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

training_plan_arn instance-attribute

training_plan_arn: NotRequired[TrainingPlanArn]

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

training_plan_status instance-attribute

training_plan_status: NotRequired[InstanceGroupTrainingPlanStatus]

The current status of the training plan associated with this cluster restricted instance group.