Class: Aws::SageMaker::Types::ClusterRestrictedInstanceGroupDetails

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

Overview

The instance group details of the restricted instance group (RIG).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#current_countInteger

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

Returns:

  • (Integer)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#environment_configTypes::EnvironmentConfigDetails

The configuration for the restricted instance groups (RIG) environment.



5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#execution_roleString

The execution role for the restricted instance group to assume.

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_group_nameString

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

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_storage_configsArray<Types::ClusterInstanceStorageConfig>

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



5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_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's restricted instance group is created or updated.

Returns:

  • (Array<String>)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_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.

Returns:



5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_update_configTypes::ScheduledUpdateConfig

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



5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the cluster's restricted instance group.

  • InService: The restricted instance group is active and healthy.

  • Creating: The restricted instance group is being provisioned.

  • Updating: The restricted instance group is being updated.

  • Failed: The restricted instance group has failed to provision or is no longer healthy.

  • Degraded: The restricted instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

  • Deleting: The restricted instance group is being deleted.

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#target_countInteger

The number of instances you specified to add to the restricted instance group of a SageMaker HyperPod cluster.

Returns:

  • (Integer)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#threads_per_coreInteger

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)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_arnString

The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan.

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_plan_statusString

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

Returns:

  • (String)


5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5080

class ClusterRestrictedInstanceGroupDetails < Struct.new(
  :current_count,
  :target_count,
  :instance_group_name,
  :instance_type,
  :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,
  :environment_config)
  SENSITIVE = []
  include Aws::Structure
end