ClusterNodeDetails
Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.
Contents
- CurrentImageId
-
The ID of the Amazon Machine Image (AMI) currently in use by the node.
Type: String
Length Constraints: Minimum length of 7. Maximum length of 21.
Pattern:
ami-[0-9a-fA-F]{8,17}|default
Required: No
- DesiredImageId
-
The ID of the Amazon Machine Image (AMI) desired for the node.
Type: String
Length Constraints: Minimum length of 7. Maximum length of 21.
Pattern:
ami-[0-9a-fA-F]{8,17}|default
Required: No
- InstanceGroupName
-
The instance group name in which the instance is.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No
- InstanceId
-
The ID of the instance.
Type: String
Required: No
- InstanceStatus
-
The status of the instance.
Type: ClusterInstanceStatusDetails object
Required: No
- InstanceStorageConfigs
-
The configurations of additional storage specified to the instance group where the instance (node) is launched.
Type: Array of ClusterInstanceStorageConfig objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
- InstanceType
-
The type of the instance.
Type: String
Valid Values:
ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5n.large | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.16xlarge | ml.g6.12xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.gr6.4xlarge | ml.gr6.8xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.16xlarge | ml.g6e.12xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.p6-b200.48xlarge | ml.trn2.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.i3en.large | ml.i3en.xlarge | ml.i3en.2xlarge | ml.i3en.3xlarge | ml.i3en.6xlarge | ml.i3en.12xlarge | ml.i3en.24xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge
Required: No
- LastSoftwareUpdateTime
-
The time when the cluster was last updated.
Type: Timestamp
Required: No
- LaunchTime
-
The time when the instance is launched.
Type: Timestamp
Required: No
- LifeCycleConfig
-
The LifeCycle configuration applied to the instance.
Type: ClusterLifeCycleConfig object
Required: No
- NodeLogicalId
-
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
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]
Required: No
- OverrideVpcConfig
-
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
Type: VpcConfig object
Required: No
- Placement
-
The placement details of the SageMaker HyperPod cluster node.
Type: ClusterInstancePlacement object
Required: No
- PrivateDnsHostname
-
The private DNS hostname of the SageMaker HyperPod cluster node.
Type: String
Pattern:
ip-((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)-?\b){4}\..*
Required: No
- PrivatePrimaryIp
-
The private primary IP address of the SageMaker HyperPod cluster node.
Type: String
Pattern:
((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}
Required: No
- PrivatePrimaryIpv6
-
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.
Type: String
Required: No
- ThreadsPerCore
-
The number of threads per CPU core you specified under
CreateCluster
.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 2.
Required: No
- UltraServerInfo
-
Contains information about the UltraServer.
Type: UltraServerInfo object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: