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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#execution_role ⇒ String

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

Returns:

  • (String) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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,
  :training_plan_arn,
  :override_vpc_config)
  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) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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

#instance_group_name ⇒ String

Specifies the name of the instance group.

Returns:

  • (String) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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,
  :training_plan_arn,
  :override_vpc_config)
  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:



4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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

#instance_type ⇒ String

Specifies the instance type of the instance group.

Returns:

  • (String) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

Specifies the LifeCycle configuration for the instance group.

Returns:



4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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,
  :training_plan_arn,
  :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>) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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

#override_vpc_config ⇒ Types::VpcConfig

To configure multi-AZ deployments, customize the VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster’s default VPC configuration. For more information about deploying a cluster in multiple AZs, see [Setting up SageMaker HyperPod clusters across multiple AZs].

<note markdown=“1”> If you configure your VPC with IPv6 support and specify subnets with IPv6 addressing enabled in your instance group VPC configuration, the nodes automatically use IPv6 addressing for network communication.

For information about adding IPv6 support for your VPC, see [IPv6

support for your VPC].

For information about creating a new VPC for use with IPv6, see

[Create a VPC].

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-multiple-availability-zones [2]: docs.aws.amazon.com/vpc/latest/userguide/vpc-migrate-ipv6.html [3]: docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html

Returns:



4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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,
  :training_plan_arn,
  :override_vpc_config)
  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*.

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

Returns:

  • (Integer) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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

#training_plan_arn ⇒ String

The Amazon Resource Name (ARN); of the training plan to use for 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) 


4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 4397

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