Class: Aws::SageMaker::Types::ClusterInstanceGroupSpecification

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClusterInstanceGroupSpecification

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

The specifications of an instance group that you need to define.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #execution_role ⇒ String

  Specifies an IAM execution role to be assumed by the instance group.

• #instance_count ⇒ Integer

  Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

• #instance_group_name ⇒ String

  Specifies the name of the instance group.

• #instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

• #instance_type ⇒ String

  Specifies the instance type of the instance group.

• #life_cycle_config ⇒ Types::ClusterLifeCycleConfig

  Specifies the LifeCycle configuration for the instance group.

• #on_start_deep_health_checks ⇒ Array<String>

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

• #threads_per_core ⇒ Integer

  Specifies the value for Threads per core.

Instance Attribute Details

#execution_role ⇒ String

Specifies an IAM execution role to be assumed by the instance group.

Returns:

• (String)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_count ⇒ Integer

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

Returns:

• (Integer)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_name ⇒ String

Specifies the name of the instance group.

Returns:

• (String)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

Returns:

• (Array<Types::ClusterInstanceStorageConfig>)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_type ⇒ String

Specifies the instance type of the instance group.

Returns:

• (String)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_config ⇒ Types::ClusterLifeCycleConfig

Specifies the LifeCycle configuration for the instance group.

Returns:

• (Types::ClusterLifeCycleConfig)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_checks ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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_core ⇒ Integer

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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.

Returns:

• (Integer)

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

class ClusterInstanceGroupSpecification < Struct.new(
  :instance_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