Skip to content

ClusterNodeDetails

Source code in docs_src/capo_sagemaker/types/cluster_node_details.py
class ClusterNodeDetails(TypedDict, closed=True):
    instance_group_name: NotRequired[
        "capo_sagemaker.types.cluster_instance_group_name.ClusterInstanceGroupName"
    ]
    """<p>The instance group name in which the instance is.</p>"""
    instance_id: NotRequired["str"]
    """<p>The ID of the instance.</p>"""
    node_logical_id: NotRequired[
        "capo_sagemaker.types.cluster_node_logical_id.ClusterNodeLogicalId"
    ]
    """<p>A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned <code>InstanceId</code>.</p>"""
    instance_status: NotRequired[
        "capo_sagemaker.types.cluster_instance_status_details.ClusterInstanceStatusDetails"
    ]
    """<p>The status of the instance.</p>"""
    instance_type: NotRequired[
        "capo_sagemaker.types.cluster_instance_type.ClusterInstanceType"
    ]
    """<p>The type of the instance.</p>"""
    launch_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the instance is launched.</p>"""
    last_software_update_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the cluster was last updated.</p>"""
    life_cycle_config: NotRequired[
        "capo_sagemaker.types.cluster_life_cycle_config.ClusterLifeCycleConfig"
    ]
    """<p>The LifeCycle configuration applied to the instance.</p>"""
    override_vpc_config: NotRequired["capo_sagemaker.types.vpc_config.VpcConfig"]
    """<p>The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.</p>"""
    threads_per_core: NotRequired[
        "capo_sagemaker.types.cluster_threads_per_core.ClusterThreadsPerCore"
    ]
    """<p>The number of threads per CPU core you specified under <code>CreateCluster</code>.</p>"""
    instance_storage_configs: NotRequired[
        "capo_sagemaker.types.cluster_instance_storage_configs.ClusterInstanceStorageConfigs"
    ]
    """<p>The configurations of additional storage specified to the instance group where the instance (node) is launched.</p>"""
    private_primary_ip: NotRequired[
        "capo_sagemaker.types.cluster_private_primary_ip.ClusterPrivatePrimaryIp"
    ]
    """<p>The private primary IP address of the SageMaker HyperPod cluster node.</p>"""
    private_primary_ipv6: NotRequired[
        "capo_sagemaker.types.cluster_private_primary_ipv6.ClusterPrivatePrimaryIpv6"
    ]
    """<p>The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.</p>"""
    private_dns_hostname: NotRequired[
        "capo_sagemaker.types.cluster_private_dns_hostname.ClusterPrivateDnsHostname"
    ]
    """<p>The private DNS hostname of the SageMaker HyperPod cluster node.</p>"""
    placement: NotRequired[
        "capo_sagemaker.types.cluster_instance_placement.ClusterInstancePlacement"
    ]
    """<p>The placement details of the SageMaker HyperPod cluster node.</p>"""
    current_image_id: NotRequired["capo_sagemaker.types.image_id.ImageId"]
    """<p>The ID of the Amazon Machine Image (AMI) currently in use by the node.</p>"""
    desired_image_id: NotRequired["capo_sagemaker.types.image_id.ImageId"]
    """<p>The ID of the Amazon Machine Image (AMI) desired for the node.</p>"""
    current_image_release_version: NotRequired[
        "capo_sagemaker.types.image_release_version.ImageReleaseVersion"
    ]
    """<p>The version of the HyperPod-managed AMI currently running on the node.</p>"""
    desired_image_release_version: NotRequired[
        "capo_sagemaker.types.image_release_version.ImageReleaseVersion"
    ]
    """<p>The desired version of the HyperPod-managed AMI for the node. This may differ from the current version when an update is pending.</p>"""
    image_version_status: NotRequired[
        "capo_sagemaker.types.cluster_image_version_status.ClusterImageVersionStatus"
    ]
    """<p>The status of the image version for the cluster node.</p>"""
    ultra_server_info: NotRequired[
        "capo_sagemaker.types.ultra_server_info.UltraServerInfo"
    ]
    """<p>Contains information about the UltraServer.</p>"""
    kubernetes_config: NotRequired[
        "capo_sagemaker.types.cluster_kubernetes_config_node_details.ClusterKubernetesConfigNodeDetails"
    ]
    """<p>The Kubernetes configuration applied to this node, showing both the current and desired state of labels and taints. The cluster works to reconcile the actual state with the declared state. </p>"""
    capacity_type: NotRequired[
        "capo_sagemaker.types.cluster_capacity_type.ClusterCapacityType"
    ]
    """<p>The capacity type of the node. Valid values are <code>OnDemand</code> and <code>Spot</code>. When set to <code>OnDemand</code>, the node is launched as an On-Demand instance. When set to <code>Spot</code>, the node is launched as a Spot instance. </p>"""
    network_interface: NotRequired[
        "capo_sagemaker.types.cluster_network_interface_details.ClusterNetworkInterfaceDetails"
    ]
    """<p>The network interface configuration for the cluster node.</p>"""

capacity_type instance-attribute

capacity_type: NotRequired[ClusterCapacityType]

The capacity type of the node. Valid values are OnDemand and Spot. When set to OnDemand, the node is launched as an On-Demand instance. When set to Spot, the node is launched as a Spot instance.

current_image_id instance-attribute

current_image_id: NotRequired[ImageId]

The ID of the Amazon Machine Image (AMI) currently in use by the node.

current_image_release_version instance-attribute

current_image_release_version: NotRequired[ImageReleaseVersion]

The version of the HyperPod-managed AMI currently running on the node.

desired_image_id instance-attribute

desired_image_id: NotRequired[ImageId]

The ID of the Amazon Machine Image (AMI) desired for the node.

desired_image_release_version instance-attribute

desired_image_release_version: NotRequired[ImageReleaseVersion]

The desired version of the HyperPod-managed AMI for the node. This may differ from the current version when an update is pending.

image_version_status instance-attribute

image_version_status: NotRequired[ClusterImageVersionStatus]

The status of the image version for the cluster node.

instance_group_name instance-attribute

instance_group_name: NotRequired[ClusterInstanceGroupName]

The instance group name in which the instance is.

instance_id instance-attribute

instance_id: NotRequired[str]

The ID of the instance.

instance_status instance-attribute

instance_status: NotRequired[ClusterInstanceStatusDetails]

The status of the instance.

instance_storage_configs instance-attribute

instance_storage_configs: NotRequired[ClusterInstanceStorageConfigs]

The configurations of additional storage specified to the instance group where the instance (node) is launched.

instance_type instance-attribute

instance_type: NotRequired[ClusterInstanceType]

The type of the instance.

kubernetes_config instance-attribute

kubernetes_config: NotRequired[ClusterKubernetesConfigNodeDetails]

The Kubernetes configuration applied to this node, showing both the current and desired state of labels and taints. The cluster works to reconcile the actual state with the declared state.

last_software_update_time instance-attribute

last_software_update_time: NotRequired[Timestamp]

The time when the cluster was last updated.

launch_time instance-attribute

launch_time: NotRequired[Timestamp]

The time when the instance is launched.

life_cycle_config instance-attribute

life_cycle_config: NotRequired[ClusterLifeCycleConfig]

The LifeCycle configuration applied to the instance.

network_interface instance-attribute

network_interface: NotRequired[ClusterNetworkInterfaceDetails]

The network interface configuration for the cluster node.

node_logical_id instance-attribute

node_logical_id: NotRequired[ClusterNodeLogicalId]

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId.

override_vpc_config instance-attribute

override_vpc_config: NotRequired[VpcConfig]

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

placement instance-attribute

placement: NotRequired[ClusterInstancePlacement]

The placement details of the SageMaker HyperPod cluster node.

private_dns_hostname instance-attribute

private_dns_hostname: NotRequired[ClusterPrivateDnsHostname]

The private DNS hostname of the SageMaker HyperPod cluster node.

private_primary_ip instance-attribute

private_primary_ip: NotRequired[ClusterPrivatePrimaryIp]

The private primary IP address of the SageMaker HyperPod cluster node.

private_primary_ipv6 instance-attribute

private_primary_ipv6: NotRequired[ClusterPrivatePrimaryIpv6]

The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

threads_per_core instance-attribute

threads_per_core: NotRequired[ClusterThreadsPerCore]

The number of threads per CPU core you specified under CreateCluster.

ultra_server_info instance-attribute

ultra_server_info: NotRequired[UltraServerInfo]

Contains information about the UltraServer.