Class: Aws::SageMaker::Types::ClusterInstanceGroupDetails

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Details of an instance group in a SageMaker HyperPod cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#current_countInteger

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

Returns:

  • (Integer)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#execution_roleString

The execution role for the instance group to assume.

Returns:

  • (String)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#instance_group_nameString

The name of the instance group of a SageMaker HyperPod cluster.

Returns:

  • (String)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#instance_storage_configsArray<Types::ClusterInstanceStorageConfig>

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



4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type of the instance group of a SageMaker HyperPod cluster.

Returns:

  • (String)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_configTypes::ClusterLifeCycleConfig

Details of LifeCycle configuration for the instance group.



4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#on_start_deep_health_checksArray<String>

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

Returns:

  • (Array<String>)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#target_countInteger

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

Returns:

  • (Integer)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end

#threads_per_coreInteger

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html

Returns:

  • (Integer)


4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
# File 'lib/aws-sdk-sagemaker/types.rb', line 4232

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :life_cycle_config,
  :execution_role,
  :threads_per_core,
  :instance_storage_configs,
  :on_start_deep_health_checks)
  SENSITIVE = []
  include Aws::Structure
end