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

Inherits:

Struct

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

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

#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

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

The configuration object of the schedule that SageMaker follows when updating the AMI.
#status ⇒ String

The current status of the cluster instance group.
#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.
#training_plan_arn ⇒ String

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
#training_plan_status ⇒ String

The current status of the training plan associated with this cluster instance group.

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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_config)
  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 4341

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

#scheduled_update_config ⇒ `Types::ScheduledUpdateConfig`

The configuration object of the schedule that SageMaker follows when updating the AMI.

Returns:

(Types::ScheduledUpdateConfig)

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

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

#status ⇒ `String`

The current status of the cluster instance group.

‘InService`: The instance group is active and healthy.
‘Creating`: The instance group is being provisioned.
‘Updating`: The instance group is being updated.
‘Failed`: The instance group has failed to provision or is no longer healthy.
‘Degraded`: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.
‘Deleting`: The instance group is being deleted.

Returns:

(String)

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

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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,
  :status,
  :training_plan_arn,
  :training_plan_status,
  :override_vpc_config,
  :scheduled_update_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 4341

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

#training_plan_arn ⇒ `String`

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ‘ CreateTrainingPlan `.

Returns:

(String)

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

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

#training_plan_status ⇒ `String`

The current status of the training plan associated with this cluster instance group.

Returns:

(String)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#current_count ⇒ Integer

#execution_role ⇒ String

#instance_group_name ⇒ String

#instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

#instance_type ⇒ String

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

#on_start_deep_health_checks ⇒ Array<String>

#override_vpc_config ⇒ Types::VpcConfig

#scheduled_update_config ⇒ Types::ScheduledUpdateConfig

#status ⇒ String

#target_count ⇒ Integer

#threads_per_core ⇒ Integer

#training_plan_arn ⇒ String

#training_plan_status ⇒ String

#current_count ⇒ `Integer`

#execution_role ⇒ `String`

#instance_group_name ⇒ `String`

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

#instance_type ⇒ `String`

#life_cycle_config ⇒ `Types::ClusterLifeCycleConfig`

#on_start_deep_health_checks ⇒ `Array<String>`

#override_vpc_config ⇒ `Types::VpcConfig`

#scheduled_update_config ⇒ `Types::ScheduledUpdateConfig`

#status ⇒ `String`

#target_count ⇒ `Integer`

#threads_per_core ⇒ `Integer`

#training_plan_arn ⇒ `String`

#training_plan_status ⇒ `String`