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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#execution_roleString

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

Returns:

  • (String)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_countInteger

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

Returns:

  • (Integer)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_nameString

Specifies the name of the instance group.

Returns:

  • (String)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_configsArray<Types::ClusterInstanceStorageConfig>

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



4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_typeString

Specifies the instance type of the instance group.

Returns:

  • (String)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_configTypes::ClusterLifeCycleConfig

Specifies the LifeCycle configuration for the instance group.



4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_checksArray<String>

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

Returns:

  • (Array<String>)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_configTypes::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:



4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_coreInteger

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)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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_arnString

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)


4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/aws-sdk-sagemaker/types.rb', line 4371

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