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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scalingTypes::ClusterAutoScalingConfig

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



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_nameString

The name for the new SageMaker HyperPod cluster.

Returns:

  • (String)


8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_roleString

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)


8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_groupsArray<Types::ClusterInstanceGroupSpecification>

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



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_modeString

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)


8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_recoveryString

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)


8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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

#orchestratorTypes::ClusterOrchestrator

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is ‘“eks”`, which is to use an Amazon Elastic Kubernetes Service cluster as the orchestrator.



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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_groupsArray<Types::ClusterRestrictedInstanceGroupSpecification>

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



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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

#tagsArray<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].

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html

Returns:



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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

<note markdown=“1”> 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][3].
  • 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].

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html [2]: docs.aws.amazon.com/eks/latest/userguide/deploy-ipv6-cluster.html#_deploy_an_ipv6_cluster_with_eksctl [3]: docs.aws.amazon.com/vpc/latest/userguide/vpc-migrate-ipv6.html [4]: docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html [5]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-optional-vpc

Returns:



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-sagemaker/types.rb', line 8198

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