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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/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

Instance Attribute Details

#current_image_idString

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

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#desired_image_idString

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

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_group_nameString

The instance group name in which the instance is.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_statusTypes::ClusterInstanceStatusDetails

The status of the instance.



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_storage_configsArray<Types::ClusterInstanceStorageConfig>

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



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The type of the instance.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#last_software_update_timeTime

The time when the cluster was last updated.

Returns:

  • (Time)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#launch_timeTime

The time when the instance is launched.

Returns:

  • (Time)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_configTypes::ClusterLifeCycleConfig

The LifeCycle configuration applied to the instance.



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#node_logical_idString

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)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#override_vpc_configTypes::VpcConfig

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

Returns:



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#placementTypes::ClusterInstancePlacement

The placement details of the SageMaker HyperPod cluster node.



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_hostnameString

The private DNS hostname of the SageMaker HyperPod cluster node.

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#private_primary_ipString

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

Returns:

  • (String)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#private_primary_ipv_6String

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)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#threads_per_coreInteger

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

Returns:

  • (Integer)


5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end

#ultra_server_infoTypes::UltraServerInfo

Contains information about the UltraServer.



5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5437

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,
  :ultra_server_info)
  SENSITIVE = []
  include Aws::Structure
end