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

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClusterInstanceGroupDetails

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

Details of an instance group in a SageMaker HyperPod cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #current_count ⇒ Integer

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

• #execution_role ⇒ String

  The execution role for the instance group to assume.

• #instance_group_name ⇒ String

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

• #instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

• #instance_type ⇒ String

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

• #life_cycle_config ⇒ Types::ClusterLifeCycleConfig

  Details of 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.

• #override_vpc_config ⇒ Types::VpcConfig

  Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

• #target_count ⇒ Integer

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

• #threads_per_core ⇒ Integer

  The number you specified to ‘TreadsPerCore` in `CreateCluster` for enabling or disabling multithreading.

Instance Attribute Details

#current_count ⇒ Integer

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

Returns:

• (Integer)

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

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

#execution_role ⇒ String

The execution role for the instance group to assume.

Returns:

• (String)

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

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

#instance_group_name ⇒ String

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

Returns:

• (String)

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

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

#instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

Returns:

• (Array<Types::ClusterInstanceStorageConfig>)

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

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

#instance_type ⇒ String

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

Returns:

• (String)

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

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

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

Details of LifeCycle configuration for the instance group.

Returns:

• (Types::ClusterLifeCycleConfig)

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

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,
  :override_vpc_config)
  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 'lib/aws-sdk-sagemaker/types.rb', line 4244

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

#override_vpc_config ⇒ Types::VpcConfig

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html

Returns:

• (Types::VpcConfig)

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

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

#target_count ⇒ Integer

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

Returns:

• (Integer)

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

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

#threads_per_core ⇒ Integer

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)

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

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