Class: Aws::SageMaker::Types::ClusterNodeDetails

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::ClusterNodeDetails

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sagemaker/types.rb

Overview

Details of an instance (also called a node interchangeably) in a SageMaker HyperPod cluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capacity_type ⇒ String

The capacity type of the node.
#current_image_id ⇒ String

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

The ID of the Amazon Machine Image (AMI) desired for the node.
#image_version_status ⇒ String

The status of the image version for the cluster node.
#instance_group_name ⇒ String

The instance group name in which the instance is.
#instance_id ⇒ String

The ID of the instance.
#instance_status ⇒ Types::ClusterInstanceStatusDetails

The status of the instance.
#instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

The type of the instance.
#kubernetes_config ⇒ Types::ClusterKubernetesConfigNodeDetails

The Kubernetes configuration applied to this node, showing both the current and desired state of labels and taints.
#last_software_update_time ⇒ Time

The time when the cluster was last updated.
#launch_time ⇒ Time

The time when the instance is launched.
#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

The LifeCycle configuration applied to the instance.
#network_interface ⇒ Types::ClusterNetworkInterfaceDetails

The network interface configuration for the cluster node.
#node_logical_id ⇒ String

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination.
#override_vpc_config ⇒ Types::VpcConfig

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
#placement ⇒ Types::ClusterInstancePlacement

The placement details of the SageMaker HyperPod cluster node.
#private_dns_hostname ⇒ String

The private DNS hostname of the SageMaker HyperPod cluster node.
#private_primary_ip ⇒ String

The private primary IP address of the SageMaker HyperPod cluster node.
#private_primary_ipv_6 ⇒ String

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 ⇒ Integer

The number of threads per CPU core you specified under ‘CreateCluster`.
#ultra_server_info ⇒ Types::UltraServerInfo

Contains information about the UltraServer.

Instance Attribute Details

#capacity_type ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#current_image_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#desired_image_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#image_version_status ⇒ `String`

The status of the image version for the cluster node.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#instance_group_name ⇒ `String`

The instance group name in which the instance is.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ `String`

The ID of the instance.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#instance_status ⇒ `Types::ClusterInstanceStatusDetails`

The status of the instance.

Returns:

(Types::ClusterInstanceStatusDetails)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#instance_storage_configs ⇒ `Array<Types::ClusterInstanceStorageConfig>`

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

Returns:

(Array<Types::ClusterInstanceStorageConfig>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

The type of the instance.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_config ⇒ `Types::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.

Returns:

(Types::ClusterKubernetesConfigNodeDetails)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#last_software_update_time ⇒ `Time`

The time when the cluster was last updated.

Returns:

(Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#launch_time ⇒ `Time`

The time when the instance is launched.

Returns:

(Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_config ⇒ `Types::ClusterLifeCycleConfig`

The LifeCycle configuration applied to the instance.

Returns:

(Types::ClusterLifeCycleConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface ⇒ `Types::ClusterNetworkInterfaceDetails`

The network interface configuration for the cluster node.

Returns:

(Types::ClusterNetworkInterfaceDetails)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#node_logical_id ⇒ `String`

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`.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#override_vpc_config ⇒ `Types::VpcConfig`

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

Returns:

(Types::VpcConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#placement ⇒ `Types::ClusterInstancePlacement`

The placement details of the SageMaker HyperPod cluster node.

Returns:

(Types::ClusterInstancePlacement)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_hostname ⇒ `String`

The private DNS hostname of the SageMaker HyperPod cluster node.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#private_primary_ip ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#private_primary_ipv_6 ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#threads_per_core ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

#ultra_server_info ⇒ `Types::UltraServerInfo`

Contains information about the UltraServer.

Returns:

(Types::UltraServerInfo)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7168

class ClusterNodeDetails < Struct.new(
  :instance_group_name,
  :instance_id,
  :node_logical_id,
  :instance_status,
  :instance_type,
  :launch_time,
  :last_software_update_time,
  :life_cycle_config,
  :override_vpc_config,
  :threads_per_core,
  :instance_storage_configs,
  :private_primary_ip,
  :private_primary_ipv_6,
  :private_dns_hostname,
  :placement,
  :current_image_id,
  :desired_image_id,
  :image_version_status,
  :ultra_server_info,
  :kubernetes_config,
  :capacity_type,
  :network_interface)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SageMaker::Types::ClusterNodeDetails

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_type ⇒ String

#current_image_id ⇒ String

#desired_image_id ⇒ String

#image_version_status ⇒ String

#instance_group_name ⇒ String

#instance_id ⇒ String

#instance_status ⇒ Types::ClusterInstanceStatusDetails

#instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

#instance_type ⇒ String

#kubernetes_config ⇒ Types::ClusterKubernetesConfigNodeDetails

#last_software_update_time ⇒ Time

#launch_time ⇒ Time

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

#network_interface ⇒ Types::ClusterNetworkInterfaceDetails

#node_logical_id ⇒ String

#override_vpc_config ⇒ Types::VpcConfig

#placement ⇒ Types::ClusterInstancePlacement

#private_dns_hostname ⇒ String

#private_primary_ip ⇒ String

#private_primary_ipv_6 ⇒ String

#threads_per_core ⇒ Integer

#ultra_server_info ⇒ Types::UltraServerInfo

#capacity_type ⇒ `String`

#current_image_id ⇒ `String`

#desired_image_id ⇒ `String`

#image_version_status ⇒ `String`

#instance_group_name ⇒ `String`

#instance_id ⇒ `String`

#instance_status ⇒ `Types::ClusterInstanceStatusDetails`

#instance_storage_configs ⇒ `Array<Types::ClusterInstanceStorageConfig>`

#instance_type ⇒ `String`

#kubernetes_config ⇒ `Types::ClusterKubernetesConfigNodeDetails`

#last_software_update_time ⇒ `Time`

#launch_time ⇒ `Time`

#life_cycle_config ⇒ `Types::ClusterLifeCycleConfig`

#network_interface ⇒ `Types::ClusterNetworkInterfaceDetails`

#node_logical_id ⇒ `String`

#override_vpc_config ⇒ `Types::VpcConfig`

#placement ⇒ `Types::ClusterInstancePlacement`

#private_dns_hostname ⇒ `String`

#private_primary_ip ⇒ `String`

#private_primary_ipv_6 ⇒ `String`

#threads_per_core ⇒ `Integer`

#ultra_server_info ⇒ `Types::UltraServerInfo`