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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-sagemaker/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

#active_operations ⇒ Hash<String,Integer>
A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster.
#active_software_update_config ⇒ Types::DeploymentConfiguration
The configuration to use when updating the AMI versions.
#capacity_requirements ⇒ Types::ClusterCapacityRequirements
The instance capacity requirements for the instance group.
#current_count ⇒ Integer
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
#current_image_id ⇒ String
The ID of the Amazon Machine Image (AMI) currently in use by the instance group.
#desired_image_id ⇒ String
The ID of the Amazon Machine Image (AMI) desired for the instance group.
#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_requirements ⇒ Types::ClusterInstanceRequirementDetails
The instance requirements for the instance group, including the current and desired instance types.
#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.
#instance_type_details ⇒ Array<Types::ClusterInstanceTypeDetail>
Details about the instance types in the instance group, including the count and configuration of each instance type.
#kubernetes_config ⇒ Types::ClusterKubernetesConfigDetails
The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.
#life_cycle_config ⇒ Types::ClusterLifeCycleConfig
Details of LifeCycle configuration for the instance group.
#min_count ⇒ Integer
The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.
#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.
#slurm_config ⇒ Types::ClusterSlurmConfigDetails
The Slurm configuration for the instance group.
#software_update_status ⇒ String
Status of the last software udpate request.
#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.
#target_state_count ⇒ Integer
Represents the number of running nodes using the desired Image ID.
#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

#active_operations ⇒ `Hash<String,Integer>`

A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

Returns:

(Hash<String,Integer>)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#active_software_update_config ⇒ `Types::DeploymentConfiguration`

The configuration to use when updating the AMI versions.

Returns:

(Types::DeploymentConfiguration)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_requirements ⇒ `Types::ClusterCapacityRequirements`

The instance capacity requirements for the instance group.

Returns:

(Types::ClusterCapacityRequirements)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_count ⇒ `Integer`

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

Returns:

(Integer)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_image_id ⇒ `String`

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

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#desired_image_id ⇒ `String`

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

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ `String`

The execution role for the instance group to assume.

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_group_name ⇒ `String`

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

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_requirements ⇒ `Types::ClusterInstanceRequirementDetails`

The instance requirements for the instance group, including the current and desired instance types. This field is present for flexible instance groups that support multiple instance types.

Returns:

(Types::ClusterInstanceRequirementDetails)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

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

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type_details ⇒ `Array<Types::ClusterInstanceTypeDetail>`

Details about the instance types in the instance group, including the count and configuration of each instance type. This field is present for flexible instance groups that support multiple instance types.

Returns:

(Array<Types::ClusterInstanceTypeDetail>)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_config ⇒ `Types::ClusterKubernetesConfigDetails`

The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

Returns:

(Types::ClusterKubernetesConfigDetails)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_config ⇒ `Types::ClusterLifeCycleConfig`

Details of LifeCycle configuration for the instance group.

Returns:

(Types::ClusterLifeCycleConfig)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#min_count ⇒ `Integer`

The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.

Returns:

(Integer)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#slurm_config ⇒ `Types::ClusterSlurmConfigDetails`

The Slurm configuration for the instance group.

Returns:

(Types::ClusterSlurmConfigDetails)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#software_update_status ⇒ `String`

Status of the last software udpate request.

Status transitions follow these possible sequences:

Pending -> InProgress -> Succeeded
Pending -> InProgress -> RollbackInProgress -> RollbackComplete
Pending -> InProgress -> RollbackInProgress -> Failed

Returns:

(String)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

#target_state_count ⇒ `Integer`

Represents the number of running nodes using the desired Image ID.

During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).
During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

Returns:

(Integer)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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.

Returns:

(Integer)

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

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5703

class ClusterInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :min_count,
  :instance_group_name,
  :instance_type,
  :instance_requirements,
  :instance_type_details,
  :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,
  :current_image_id,
  :desired_image_id,
  :active_operations,
  :kubernetes_config,
  :capacity_requirements,
  :target_state_count,
  :software_update_status,
  :active_software_update_config,
  :slurm_config)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#active_operations ⇒ Hash<String,Integer>

#active_software_update_config ⇒ Types::DeploymentConfiguration

#capacity_requirements ⇒ Types::ClusterCapacityRequirements

#current_count ⇒ Integer

#current_image_id ⇒ String

#desired_image_id ⇒ String

#execution_role ⇒ String

#instance_group_name ⇒ String

#instance_requirements ⇒ Types::ClusterInstanceRequirementDetails

#instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

#instance_type ⇒ String

#instance_type_details ⇒ Array<Types::ClusterInstanceTypeDetail>

#kubernetes_config ⇒ Types::ClusterKubernetesConfigDetails

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

#min_count ⇒ Integer

#on_start_deep_health_checks ⇒ Array<String>

#override_vpc_config ⇒ Types::VpcConfig

#scheduled_update_config ⇒ Types::ScheduledUpdateConfig

#slurm_config ⇒ Types::ClusterSlurmConfigDetails

#software_update_status ⇒ String

#status ⇒ String

#target_count ⇒ Integer

#target_state_count ⇒ Integer

#threads_per_core ⇒ Integer

#training_plan_arn ⇒ String

#training_plan_status ⇒ String

#active_operations ⇒ `Hash<String,Integer>`

#active_software_update_config ⇒ `Types::DeploymentConfiguration`

#capacity_requirements ⇒ `Types::ClusterCapacityRequirements`

#current_count ⇒ `Integer`

#current_image_id ⇒ `String`

#desired_image_id ⇒ `String`

#execution_role ⇒ `String`

#instance_group_name ⇒ `String`

#instance_requirements ⇒ `Types::ClusterInstanceRequirementDetails`

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

#instance_type ⇒ `String`

#instance_type_details ⇒ `Array<Types::ClusterInstanceTypeDetail>`

#kubernetes_config ⇒ `Types::ClusterKubernetesConfigDetails`

#life_cycle_config ⇒ `Types::ClusterLifeCycleConfig`

#min_count ⇒ `Integer`

#on_start_deep_health_checks ⇒ `Array<String>`

#override_vpc_config ⇒ `Types::VpcConfig`

#scheduled_update_config ⇒ `Types::ScheduledUpdateConfig`

#slurm_config ⇒ `Types::ClusterSlurmConfigDetails`

#software_update_status ⇒ `String`

#status ⇒ `String`

#target_count ⇒ `Integer`

#target_state_count ⇒ `Integer`

#threads_per_core ⇒ `Integer`

#training_plan_arn ⇒ `String`

#training_plan_status ⇒ `String`