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

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClusterInstanceGroupSpecification

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #execution_role ⇒ String

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

• #image_id ⇒ String

  When configuring your HyperPod cluster, you can specify an image ID using one of the following options:.

• #instance_count ⇒ Integer

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

• #instance_group_name ⇒ String

  Specifies the name of the instance group.

• #instance_storage_configs ⇒ Array<Types::ClusterInstanceStorageConfig>

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

• #instance_type ⇒ String

  Specifies the instance type of the instance group.

• #life_cycle_config ⇒ Types::ClusterLifeCycleConfig

  Specifies the 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

  To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level.

• #scheduled_update_config ⇒ Types::ScheduledUpdateConfig

  The configuration object of the schedule that SageMaker uses to update the AMI.

• #threads_per_core ⇒ Integer

  Specifies the value for Threads per core.

• #training_plan_arn ⇒ String

  The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

Instance Attribute Details

#execution_role ⇒ String

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

Returns:

• (String)

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

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

#image_id ⇒ String

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

• HyperPodPublicAmiId: Use a HyperPod public AMI

• CustomAmiId: Use your custom AMI

• default: Use the default latest system image

f you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

• Encryption: The custom AMI must be unencrypted.

• Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

• Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.

Returns:

• (String)

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

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,
  :scheduled_update_config,
  :image_id)
  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)

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

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

#instance_group_name ⇒ String

Specifies the name of the instance group.

Returns:

• (String)

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

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,
  :scheduled_update_config,
  :image_id)
  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:

• (Array<Types::ClusterInstanceStorageConfig>)

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

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

#instance_type ⇒ String

Specifies the instance type of the instance group.

Returns:

• (String)

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

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

#life_cycle_config ⇒ Types::ClusterLifeCycleConfig

Specifies the LifeCycle configuration for the instance group.

Returns:

• (Types::ClusterLifeCycleConfig)

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

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,
  :scheduled_update_config,
  :image_id)
  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 5103

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

#override_vpc_config ⇒ Types::VpcConfig

To configure multi-AZ deployments, customize the Amazon 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 Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

• Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

• In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

Additional resources for IPv6 configuration:

• For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.

• For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.

• To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.

Returns:

• (Types::VpcConfig)

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

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

#scheduled_update_config ⇒ Types::ScheduledUpdateConfig

The configuration object of the schedule that SageMaker uses to update the AMI.

Returns:

• (Types::ScheduledUpdateConfig)

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

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,
  :scheduled_update_config,
  :image_id)
  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.

Returns:

• (Integer)

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

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,
  :scheduled_update_config,
  :image_id)
  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)

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

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