Class: Aws::SageMaker::Types::CreateClusterRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateClusterRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_scaling ⇒ Types::ClusterAutoScalingConfig

  The autoscaling configuration for the cluster.

• #cluster_name ⇒ String

  The name for the new SageMaker HyperPod cluster.

• #cluster_role ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations.

• #instance_groups ⇒ Array<Types::ClusterInstanceGroupSpecification>

  The instance groups to be created in the SageMaker HyperPod cluster.

• #node_provisioning_mode ⇒ String

  The mode for provisioning nodes in the cluster.

• #node_recovery ⇒ String

  The node recovery mode for the SageMaker HyperPod cluster.

• #orchestrator ⇒ Types::ClusterOrchestrator

  The type of orchestrator to use for the SageMaker HyperPod cluster.

• #restricted_instance_groups ⇒ Array<Types::ClusterRestrictedInstanceGroupSpecification>

  The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

• #tags ⇒ Array<Types::Tag>

  Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource.

• #tiered_storage_config ⇒ Types::ClusterTieredStorageConfig

  The configuration for managed tier checkpointing on the HyperPod cluster.

• #vpc_config ⇒ Types::VpcConfig

  Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster.

Instance Attribute Details

#auto_scaling ⇒ Types::ClusterAutoScalingConfig

The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

Returns:

• (Types::ClusterAutoScalingConfig)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name for the new SageMaker HyperPod cluster.

Returns:

• (String)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_role ⇒ String

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

Returns:

• (String)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#instance_groups ⇒ Array<Types::ClusterInstanceGroupSpecification>

The instance groups to be created in the SageMaker HyperPod cluster.

Returns:

• (Array<Types::ClusterInstanceGroupSpecification>)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#node_provisioning_mode ⇒ String

The mode for provisioning nodes in the cluster. You can specify the following modes:

• Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

^

Returns:

• (String)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#node_recovery ⇒ String

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

Returns:

• (String)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#orchestrator ⇒ Types::ClusterOrchestrator

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, supported values are "Eks" and "Slurm", which is to use an Amazon Elastic Kubernetes Service or Slurm cluster as the orchestrator.

If you specify the Orchestrator field, you must provide exactly one orchestrator configuration: either Eks or Slurm. Specifying both or providing an empty configuration returns a validation error.

Returns:

• (Types::ClusterOrchestrator)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#restricted_instance_groups ⇒ Array<Types::ClusterRestrictedInstanceGroupSpecification>

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

Returns:

• (Array<Types::ClusterRestrictedInstanceGroupSpecification>)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

Returns:

• (Array<Types::Tag>)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#tiered_storage_config ⇒ Types::ClusterTieredStorageConfig

The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

Returns:

• (Types::ClusterTieredStorageConfig)

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

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

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 8342

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :restricted_instance_groups,
  :vpc_config,
  :tags,
  :orchestrator,
  :node_recovery,
  :tiered_storage_config,
  :node_provisioning_mode,
  :cluster_role,
  :auto_scaling)
  SENSITIVE = []
  include Aws::Structure
end