Skip to content

ClusterRestrictedInstanceGroupSpecification

Source code in docs_src/capo_sagemaker/types/cluster_restricted_instance_group_specification.py
class ClusterRestrictedInstanceGroupSpecification(TypedDict, closed=True):
    instance_count: NotRequired[
        "capo_sagemaker.types.cluster_instance_count.ClusterInstanceCount"
    ]
    """<p>Specifies the number of instances 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>Specifies the name of the restricted instance group.</p>"""
    instance_type: NotRequired[
        "capo_sagemaker.types.cluster_instance_type.ClusterInstanceType"
    ]
    """<p>Specifies the instance type of the restricted instance group.</p>"""
    execution_role: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>Specifies an IAM execution role to be assumed by the restricted instance group.</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>Specifies 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 restricted instance group is created or updated.</p>"""
    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>"""
    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.EnvironmentConfig"
    ]
    """<p>The configuration for the restricted instance groups (RIG) environment.</p>"""

environment_config instance-attribute

environment_config: NotRequired[EnvironmentConfig]

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

execution_role instance-attribute

execution_role: NotRequired[RoleArn]

Specifies an IAM execution role to be assumed by the restricted instance group.

instance_count instance-attribute

instance_count: NotRequired[ClusterInstanceCount]

Specifies the number of instances to add to the restricted instance group of a SageMaker HyperPod cluster.

instance_group_name instance-attribute

instance_group_name: NotRequired[ClusterInstanceGroupName]

Specifies the name of the restricted instance group.

instance_storage_configs instance-attribute

instance_storage_configs: NotRequired[ClusterInstanceStorageConfigs]

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

instance_type instance-attribute

instance_type: NotRequired[ClusterInstanceType]

Specifies the instance type of the restricted instance group.

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 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]

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 .