This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SageMaker::Cluster
<a name="aws-resource-sagemaker-cluster"></a>

Creates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see [Amazon SageMaker HyperPod](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html) in the *Amazon SageMaker Developer Guide*.

## Syntax
<a name="aws-resource-sagemaker-cluster-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-sagemaker-cluster-syntax.json"></a>

```
{
  "Type" : "AWS::SageMaker::Cluster",
  "Properties" : {
      "[AutoScaling](#cfn-sagemaker-cluster-autoscaling)" : ClusterAutoScalingConfig,
      "[ClusterName](#cfn-sagemaker-cluster-clustername)" : String,
      "[ClusterRole](#cfn-sagemaker-cluster-clusterrole)" : String,
      "[InstanceGroups](#cfn-sagemaker-cluster-instancegroups)" : [ ClusterInstanceGroup, ... ],
      "[NodeProvisioningMode](#cfn-sagemaker-cluster-nodeprovisioningmode)" : String,
      "[NodeRecovery](#cfn-sagemaker-cluster-noderecovery)" : String,
      "[Orchestrator](#cfn-sagemaker-cluster-orchestrator)" : Orchestrator,
      "[RestrictedInstanceGroups](#cfn-sagemaker-cluster-restrictedinstancegroups)" : [ ClusterRestrictedInstanceGroup, ... ],
      "[Tags](#cfn-sagemaker-cluster-tags)" : [ Tag, ... ],
      "[TieredStorageConfig](#cfn-sagemaker-cluster-tieredstorageconfig)" : TieredStorageConfig,
      "[VpcConfig](#cfn-sagemaker-cluster-vpcconfig)" : VpcConfig
    }
}
```

### YAML
<a name="aws-resource-sagemaker-cluster-syntax.yaml"></a>

```
Type: AWS::SageMaker::Cluster
Properties:
  [AutoScaling](#cfn-sagemaker-cluster-autoscaling): 
    ClusterAutoScalingConfig
  [ClusterName](#cfn-sagemaker-cluster-clustername): String
  [ClusterRole](#cfn-sagemaker-cluster-clusterrole): String
  [InstanceGroups](#cfn-sagemaker-cluster-instancegroups): 
    - ClusterInstanceGroup
  [NodeProvisioningMode](#cfn-sagemaker-cluster-nodeprovisioningmode): String
  [NodeRecovery](#cfn-sagemaker-cluster-noderecovery): String
  [Orchestrator](#cfn-sagemaker-cluster-orchestrator): 
    Orchestrator
  [RestrictedInstanceGroups](#cfn-sagemaker-cluster-restrictedinstancegroups): 
    - ClusterRestrictedInstanceGroup
  [Tags](#cfn-sagemaker-cluster-tags): 
    - Tag
  [TieredStorageConfig](#cfn-sagemaker-cluster-tieredstorageconfig): 
    TieredStorageConfig
  [VpcConfig](#cfn-sagemaker-cluster-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-resource-sagemaker-cluster-properties"></a>

`AutoScaling`  <a name="cfn-sagemaker-cluster-autoscaling"></a>
The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.  
*Required*: No  
*Type*: [ClusterAutoScalingConfig](aws-properties-sagemaker-cluster-clusterautoscalingconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClusterName`  <a name="cfn-sagemaker-cluster-clustername"></a>
The name of the SageMaker HyperPod cluster.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ClusterRole`  <a name="cfn-sagemaker-cluster-clusterrole"></a>
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.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceGroups`  <a name="cfn-sagemaker-cluster-instancegroups"></a>
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.  
*Required*: No  
*Type*: Array of [ClusterInstanceGroup](aws-properties-sagemaker-cluster-clusterinstancegroup.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NodeProvisioningMode`  <a name="cfn-sagemaker-cluster-nodeprovisioningmode"></a>
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.
*Required*: No  
*Type*: String  
*Allowed values*: `Continuous`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NodeRecovery`  <a name="cfn-sagemaker-cluster-noderecovery"></a>
Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values are `Automatic` for enabling and `None` for disabling.  
*Required*: No  
*Type*: String  
*Allowed values*: `Automatic | None`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Orchestrator`  <a name="cfn-sagemaker-cluster-orchestrator"></a>
The orchestrator type for the SageMaker HyperPod cluster. Currently, `'eks'` is the only available option.  
*Required*: No  
*Type*: [Orchestrator](aws-properties-sagemaker-cluster-orchestrator.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestrictedInstanceGroups`  <a name="cfn-sagemaker-cluster-restrictedinstancegroups"></a>
The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.  
*Required*: No  
*Type*: Array of [ClusterRestrictedInstanceGroup](aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-sagemaker-cluster-tags"></a>
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.  
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).  
For more information on adding metadata to your AWS resources with tagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing AWS resources with tagging, see [Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-sagemaker-cluster-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TieredStorageConfig`  <a name="cfn-sagemaker-cluster-tieredstorageconfig"></a>
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.  
*Required*: No  
*Type*: [TieredStorageConfig](aws-properties-sagemaker-cluster-tieredstorageconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfig`  <a name="cfn-sagemaker-cluster-vpcconfig"></a>
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](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).   
*Required*: No  
*Type*: [VpcConfig](aws-properties-sagemaker-cluster-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-sagemaker-cluster-return-values"></a>

### Ref
<a name="aws-resource-sagemaker-cluster-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-sagemaker-cluster-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-sagemaker-cluster-return-values-fn--getatt-fn--getatt"></a>

`ClusterArn`  <a name="ClusterArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

`ClusterStatus`  <a name="ClusterStatus-fn::getatt"></a>
The status of the SageMaker HyperPod cluster.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
The time when the SageMaker HyperPod cluster is created.

`FailureMessage`  <a name="FailureMessage-fn::getatt"></a>
The failure message of the SageMaker HyperPod cluster.

# AWS::SageMaker::Cluster AlarmDetails
<a name="aws-properties-sagemaker-cluster-alarmdetails"></a>

The details of the alarm to monitor during the AMI update.

## Syntax
<a name="aws-properties-sagemaker-cluster-alarmdetails-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-alarmdetails-syntax.json"></a>

```
{
  "[AlarmName](#cfn-sagemaker-cluster-alarmdetails-alarmname)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-alarmdetails-syntax.yaml"></a>

```
  [AlarmName](#cfn-sagemaker-cluster-alarmdetails-alarmname): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-alarmdetails-properties"></a>

`AlarmName`  <a name="cfn-sagemaker-cluster-alarmdetails-alarmname"></a>
The name of the alarm.  
*Required*: Yes  
*Type*: String  
*Pattern*: `(?!\s*$).+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster CapacitySizeConfig
<a name="aws-properties-sagemaker-cluster-capacitysizeconfig"></a>

The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.

## Syntax
<a name="aws-properties-sagemaker-cluster-capacitysizeconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-capacitysizeconfig-syntax.json"></a>

```
{
  "[Type](#cfn-sagemaker-cluster-capacitysizeconfig-type)" : String,
  "[Value](#cfn-sagemaker-cluster-capacitysizeconfig-value)" : Integer
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-capacitysizeconfig-syntax.yaml"></a>

```
  [Type](#cfn-sagemaker-cluster-capacitysizeconfig-type): String
  [Value](#cfn-sagemaker-cluster-capacitysizeconfig-value): Integer
```

## Properties
<a name="aws-properties-sagemaker-cluster-capacitysizeconfig-properties"></a>

`Type`  <a name="cfn-sagemaker-cluster-capacitysizeconfig-type"></a>
Specifies whether SageMaker should process the update by amount or percentage of instances.  
*Required*: Yes  
*Type*: String  
*Pattern*: `INSTANCE_COUNT|CAPACITY_PERCENTAGE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-cluster-capacitysizeconfig-value"></a>
Specifies the amount or percentage of instances SageMaker updates at a time.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterAutoScalingConfig
<a name="aws-properties-sagemaker-cluster-clusterautoscalingconfig"></a>

Specifies the autoscaling configuration for a HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterautoscalingconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterautoscalingconfig-syntax.json"></a>

```
{
  "[AutoScalerType](#cfn-sagemaker-cluster-clusterautoscalingconfig-autoscalertype)" : String,
  "[Mode](#cfn-sagemaker-cluster-clusterautoscalingconfig-mode)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterautoscalingconfig-syntax.yaml"></a>

```
  [AutoScalerType](#cfn-sagemaker-cluster-clusterautoscalingconfig-autoscalertype): String
  [Mode](#cfn-sagemaker-cluster-clusterautoscalingconfig-mode): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterautoscalingconfig-properties"></a>

`AutoScalerType`  <a name="cfn-sagemaker-cluster-clusterautoscalingconfig-autoscalertype"></a>
The type of autoscaler to use. Currently supported value is `Karpenter`.  
*Required*: No  
*Type*: String  
*Allowed values*: `Karpenter`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mode`  <a name="cfn-sagemaker-cluster-clusterautoscalingconfig-mode"></a>
Describes whether autoscaling is enabled or disabled for the cluster. Valid values are `Enable` and `Disable`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Enable | Disable`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterCapacityRequirements
<a name="aws-properties-sagemaker-cluster-clustercapacityrequirements"></a>

Defines the instance capacity requirements for an instance group, including configurations for both Spot and On-Demand capacity types. 

## Syntax
<a name="aws-properties-sagemaker-cluster-clustercapacityrequirements-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clustercapacityrequirements-syntax.json"></a>

```
{
  "[OnDemand](#cfn-sagemaker-cluster-clustercapacityrequirements-ondemand)" : Json,
  "[Spot](#cfn-sagemaker-cluster-clustercapacityrequirements-spot)" : Json
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clustercapacityrequirements-syntax.yaml"></a>

```
  [OnDemand](#cfn-sagemaker-cluster-clustercapacityrequirements-ondemand): Json
  [Spot](#cfn-sagemaker-cluster-clustercapacityrequirements-spot): Json
```

## Properties
<a name="aws-properties-sagemaker-cluster-clustercapacityrequirements-properties"></a>

`OnDemand`  <a name="cfn-sagemaker-cluster-clustercapacityrequirements-ondemand"></a>
Configuration options specific to On-Demand instances.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Spot`  <a name="cfn-sagemaker-cluster-clustercapacityrequirements-spot"></a>
Configuration options specific to Spot instances.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterEbsVolumeConfig
<a name="aws-properties-sagemaker-cluster-clusterebsvolumeconfig"></a>

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620).

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterebsvolumeconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterebsvolumeconfig-syntax.json"></a>

```
{
  "[RootVolume](#cfn-sagemaker-cluster-clusterebsvolumeconfig-rootvolume)" : Boolean,
  "[VolumeKmsKeyId](#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumekmskeyid)" : String,
  "[VolumeSizeInGB](#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb)" : Integer
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterebsvolumeconfig-syntax.yaml"></a>

```
  [RootVolume](#cfn-sagemaker-cluster-clusterebsvolumeconfig-rootvolume): Boolean
  [VolumeKmsKeyId](#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumekmskeyid): String
  [VolumeSizeInGB](#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb): Integer
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterebsvolumeconfig-properties"></a>

`RootVolume`  <a name="cfn-sagemaker-cluster-clusterebsvolumeconfig-rootvolume"></a>
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two `ClusterEbsVolumeConfig` fields to configure both the root and secondary volumes. Set the value to `True` if you'd like to provide your own customer managed AWS KMS key to encrypt the root volume. When `True`:  
+ The configuration is applied to the root volume.
+ You can't specify the `VolumeSizeInGB` field. The size of the root volume is determined for you.
+ You must specify a KMS key ID for `VolumeKmsKeyId` to encrypt the root volume with your own KMS key instead of an AWS owned KMS key.
Otherwise, by default, the value is `False`, and the following applies:  
+ The configuration is applied to the secondary volume, while the root volume is encrypted with an AWS owned key.
+ You must specify the `VolumeSizeInGB` field.
+ You can optionally specify the `VolumeKmsKeyId` to encrypt the secondary volume with your own KMS key instead of an AWS owned KMS key.
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VolumeKmsKeyId`  <a name="cfn-sagemaker-cluster-clusterebsvolumeconfig-volumekmskeyid"></a>
The ID of a KMS key to encrypt the Amazon EBS volume.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9:/_-]*$`  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VolumeSizeInGB`  <a name="cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb"></a>
The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to `/opt/sagemaker`.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `16384`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterFsxLustreConfig
<a name="aws-properties-sagemaker-cluster-clusterfsxlustreconfig"></a>

Defines the configuration for attaching an Amazon FSx for Lustre file system to instances in a SageMaker HyperPod cluster instance group.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterfsxlustreconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterfsxlustreconfig-syntax.json"></a>

```
{
  "[DnsName](#cfn-sagemaker-cluster-clusterfsxlustreconfig-dnsname)" : String,
  "[MountName](#cfn-sagemaker-cluster-clusterfsxlustreconfig-mountname)" : String,
  "[MountPath](#cfn-sagemaker-cluster-clusterfsxlustreconfig-mountpath)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterfsxlustreconfig-syntax.yaml"></a>

```
  [DnsName](#cfn-sagemaker-cluster-clusterfsxlustreconfig-dnsname): String
  [MountName](#cfn-sagemaker-cluster-clusterfsxlustreconfig-mountname): String
  [MountPath](#cfn-sagemaker-cluster-clusterfsxlustreconfig-mountpath): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterfsxlustreconfig-properties"></a>

`DnsName`  <a name="cfn-sagemaker-cluster-clusterfsxlustreconfig-dnsname"></a>
The DNS name of the Amazon FSx for Lustre file system.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^((fs|fc)i?-[0-9a-f]{8,}\..{4,253})$`  
*Minimum*: `16`  
*Maximum*: `275`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MountName`  <a name="cfn-sagemaker-cluster-clusterfsxlustreconfig-mountname"></a>
The mount name of the Amazon FSx for Lustre file system.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([A-Za-z0-9_-]{1,8})$`  
*Minimum*: `1`  
*Maximum*: `8`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MountPath`  <a name="cfn-sagemaker-cluster-clusterfsxlustreconfig-mountpath"></a>
The local path where the Amazon FSx for Lustre file system is mounted on instances.  
*Required*: No  
*Type*: String  
*Pattern*: `^/(?!/)(?!.*/$)[a-zA-Z0-9._-]+(/[a-zA-Z0-9._-]+)*$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterFsxOpenZfsConfig
<a name="aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig"></a>

Defines the configuration for attaching an Amazon FSx for OpenZFS file system to instances in a SageMaker HyperPod cluster instance group.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig-syntax.json"></a>

```
{
  "[DnsName](#cfn-sagemaker-cluster-clusterfsxopenzfsconfig-dnsname)" : String,
  "[MountPath](#cfn-sagemaker-cluster-clusterfsxopenzfsconfig-mountpath)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig-syntax.yaml"></a>

```
  [DnsName](#cfn-sagemaker-cluster-clusterfsxopenzfsconfig-dnsname): String
  [MountPath](#cfn-sagemaker-cluster-clusterfsxopenzfsconfig-mountpath): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig-properties"></a>

`DnsName`  <a name="cfn-sagemaker-cluster-clusterfsxopenzfsconfig-dnsname"></a>
The DNS name of the Amazon FSx for OpenZFS file system.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^((fs|fc)i?-[0-9a-f]{8,}\..{4,253})$`  
*Minimum*: `16`  
*Maximum*: `275`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MountPath`  <a name="cfn-sagemaker-cluster-clusterfsxopenzfsconfig-mountpath"></a>
The local path where the Amazon FSx for OpenZFS file system is mounted on instances.  
*Required*: No  
*Type*: String  
*Pattern*: `^/(?!/)(?!.*/$)[a-zA-Z0-9._-]+(/[a-zA-Z0-9._-]+)*$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterInstanceGroup
<a name="aws-properties-sagemaker-cluster-clusterinstancegroup"></a>

The configuration information of the instance group within the HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterinstancegroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterinstancegroup-syntax.json"></a>

```
{
  "[CapacityRequirements](#cfn-sagemaker-cluster-clusterinstancegroup-capacityrequirements)" : ClusterCapacityRequirements,
  "[CurrentCount](#cfn-sagemaker-cluster-clusterinstancegroup-currentcount)" : Integer,
  "[ExecutionRole](#cfn-sagemaker-cluster-clusterinstancegroup-executionrole)" : String,
  "[ImageId](#cfn-sagemaker-cluster-clusterinstancegroup-imageid)" : String,
  "[InstanceCount](#cfn-sagemaker-cluster-clusterinstancegroup-instancecount)" : Integer,
  "[InstanceGroupName](#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname)" : String,
  "[InstanceStorageConfigs](#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs)" : [ ClusterInstanceStorageConfig, ... ],
  "[InstanceType](#cfn-sagemaker-cluster-clusterinstancegroup-instancetype)" : String,
  "[KubernetesConfig](#cfn-sagemaker-cluster-clusterinstancegroup-kubernetesconfig)" : ClusterKubernetesConfig,
  "[LifeCycleConfig](#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig)" : ClusterLifeCycleConfig,
  "[MinInstanceCount](#cfn-sagemaker-cluster-clusterinstancegroup-mininstancecount)" : Integer,
  "[OnStartDeepHealthChecks](#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks)" : [ String, ... ],
  "[OverrideVpcConfig](#cfn-sagemaker-cluster-clusterinstancegroup-overridevpcconfig)" : VpcConfig,
  "[ScheduledUpdateConfig](#cfn-sagemaker-cluster-clusterinstancegroup-scheduledupdateconfig)" : ScheduledUpdateConfig,
  "[SlurmConfig](#cfn-sagemaker-cluster-clusterinstancegroup-slurmconfig)" : ClusterSlurmConfig,
  "[ThreadsPerCore](#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore)" : Integer,
  "[TrainingPlanArn](#cfn-sagemaker-cluster-clusterinstancegroup-trainingplanarn)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterinstancegroup-syntax.yaml"></a>

```
  [CapacityRequirements](#cfn-sagemaker-cluster-clusterinstancegroup-capacityrequirements): 
    ClusterCapacityRequirements
  [CurrentCount](#cfn-sagemaker-cluster-clusterinstancegroup-currentcount): Integer
  [ExecutionRole](#cfn-sagemaker-cluster-clusterinstancegroup-executionrole): String
  [ImageId](#cfn-sagemaker-cluster-clusterinstancegroup-imageid): String
  [InstanceCount](#cfn-sagemaker-cluster-clusterinstancegroup-instancecount): Integer
  [InstanceGroupName](#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname): String
  [InstanceStorageConfigs](#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs): 
    - ClusterInstanceStorageConfig
  [InstanceType](#cfn-sagemaker-cluster-clusterinstancegroup-instancetype): String
  [KubernetesConfig](#cfn-sagemaker-cluster-clusterinstancegroup-kubernetesconfig): 
    ClusterKubernetesConfig
  [LifeCycleConfig](#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig): 
    ClusterLifeCycleConfig
  [MinInstanceCount](#cfn-sagemaker-cluster-clusterinstancegroup-mininstancecount): Integer
  [OnStartDeepHealthChecks](#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks): 
    - String
  [OverrideVpcConfig](#cfn-sagemaker-cluster-clusterinstancegroup-overridevpcconfig): 
    VpcConfig
  [ScheduledUpdateConfig](#cfn-sagemaker-cluster-clusterinstancegroup-scheduledupdateconfig): 
    ScheduledUpdateConfig
  [SlurmConfig](#cfn-sagemaker-cluster-clusterinstancegroup-slurmconfig): 
    ClusterSlurmConfig
  [ThreadsPerCore](#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore): Integer
  [TrainingPlanArn](#cfn-sagemaker-cluster-clusterinstancegroup-trainingplanarn): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterinstancegroup-properties"></a>

`CapacityRequirements`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-capacityrequirements"></a>
The capacity requirements for the instance group, specifying on-demand and spot instance configurations.  
*Required*: No  
*Type*: [ClusterCapacityRequirements](aws-properties-sagemaker-cluster-clustercapacityrequirements.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CurrentCount`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-currentcount"></a>
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRole`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-executionrole"></a>
The execution role for the instance group to assume.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ImageId`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-imageid"></a>
The ID of the Amazon Machine Image (AMI) to use for the instances in the group.  
*Required*: No  
*Type*: String  
*Pattern*: `^ami-[0-9a-fA-F]{8,17}|default$`  
*Minimum*: `7`  
*Maximum*: `21`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceCount`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-instancecount"></a>
The number of instances in an instance group of the SageMaker HyperPod cluster.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceGroupName`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname"></a>
The name of the instance group of a SageMaker HyperPod cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`InstanceStorageConfigs`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs"></a>
The configurations of additional storage specified to the instance group where the instance (node) is launched.  
*Required*: No  
*Type*: Array of [ClusterInstanceStorageConfig](aws-properties-sagemaker-cluster-clusterinstancestorageconfig.md)  
*Maximum*: `4`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceType`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-instancetype"></a>
The instance type of the instance group of a SageMaker HyperPod cluster.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ml.p4d.24xlarge | ml.p4de.24xlarge | ml.p5.48xlarge | ml.p5.4xlarge | ml.p6e-gb200.36xlarge | ml.trn1.32xlarge | ml.trn1n.32xlarge | ml.g5.xlarge | ml.g5.2xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.48xlarge | ml.c5.large | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5n.large | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.18xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.t3.medium | ml.t3.large | ml.t3.xlarge | ml.t3.2xlarge | ml.g6.xlarge | ml.g6.2xlarge | ml.g6.4xlarge | ml.g6.8xlarge | ml.g6.16xlarge | ml.g6.12xlarge | ml.g6.24xlarge | ml.g6.48xlarge | ml.gr6.4xlarge | ml.gr6.8xlarge | ml.g6e.xlarge | ml.g6e.2xlarge | ml.g6e.4xlarge | ml.g6e.8xlarge | ml.g6e.16xlarge | ml.g6e.12xlarge | ml.g6e.24xlarge | ml.g6e.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.p6-b200.48xlarge | ml.trn2.3xlarge | ml.trn2.48xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c6i.2xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.32xlarge | ml.m6i.large | ml.m6i.xlarge | ml.m6i.2xlarge | ml.m6i.4xlarge | ml.m6i.8xlarge | ml.m6i.12xlarge | ml.m6i.16xlarge | ml.m6i.24xlarge | ml.m6i.32xlarge | ml.r6i.large | ml.r6i.xlarge | ml.r6i.2xlarge | ml.r6i.4xlarge | ml.r6i.8xlarge | ml.r6i.12xlarge | ml.r6i.16xlarge | ml.r6i.24xlarge | ml.r6i.32xlarge | ml.i3en.large | ml.i3en.xlarge | ml.i3en.2xlarge | ml.i3en.3xlarge | ml.i3en.6xlarge | ml.i3en.12xlarge | ml.i3en.24xlarge | ml.m7i.large | ml.m7i.xlarge | ml.m7i.2xlarge | ml.m7i.4xlarge | ml.m7i.8xlarge | ml.m7i.12xlarge | ml.m7i.16xlarge | ml.m7i.24xlarge | ml.m7i.48xlarge | ml.r7i.large | ml.r7i.xlarge | ml.r7i.2xlarge | ml.r7i.4xlarge | ml.r7i.8xlarge | ml.r7i.12xlarge | ml.r7i.16xlarge | ml.r7i.24xlarge | ml.r7i.48xlarge | ml.r5d.16xlarge | ml.g7e.2xlarge | ml.g7e.4xlarge | ml.g7e.8xlarge | ml.g7e.12xlarge | ml.g7e.24xlarge | ml.g7e.48xlarge | ml.p6-b300.48xlarge`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KubernetesConfig`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-kubernetesconfig"></a>
The Kubernetes configuration for the instance group, including labels and taints.  
*Required*: No  
*Type*: [ClusterKubernetesConfig](aws-properties-sagemaker-cluster-clusterkubernetesconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LifeCycleConfig`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig"></a>
The lifecycle configuration for a SageMaker HyperPod cluster.  
*Required*: No  
*Type*: [ClusterLifeCycleConfig](aws-properties-sagemaker-cluster-clusterlifecycleconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinInstanceCount`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-mininstancecount"></a>
The minimum number of instances to maintain in the instance group.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OnStartDeepHealthChecks`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks"></a>
A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated. Deep health checks are comprehensive, invasive tests that validate the health of the underlying hardware and infrastructure components.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OverrideVpcConfig`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-overridevpcconfig"></a>
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-sagemaker-cluster-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduledUpdateConfig`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-scheduledupdateconfig"></a>
Configuration for scheduled updates to the instance group.  
*Required*: No  
*Type*: [ScheduledUpdateConfig](aws-properties-sagemaker-cluster-scheduledupdateconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SlurmConfig`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-slurmconfig"></a>
The Slurm workload manager configuration for the instance group.  
*Required*: No  
*Type*: [ClusterSlurmConfig](aws-properties-sagemaker-cluster-clusterslurmconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThreadsPerCore`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-threadspercore"></a>
The number of threads per CPU core you specified under `CreateCluster`.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TrainingPlanArn`  <a name="cfn-sagemaker-cluster-clusterinstancegroup-trainingplanarn"></a>
The Amazon Resource Name (ARN) of the training plan associated with the instance group.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$`  
*Minimum*: `50`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterInstanceStorageConfig
<a name="aws-properties-sagemaker-cluster-clusterinstancestorageconfig"></a>

Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620).

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterinstancestorageconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterinstancestorageconfig-syntax.json"></a>

```
{
  "[EbsVolumeConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig)" : ClusterEbsVolumeConfig,
  "[FsxLustreConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxlustreconfig)" : ClusterFsxLustreConfig,
  "[FsxOpenZfsConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxopenzfsconfig)" : ClusterFsxOpenZfsConfig
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterinstancestorageconfig-syntax.yaml"></a>

```
  [EbsVolumeConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig): 
    ClusterEbsVolumeConfig
  [FsxLustreConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxlustreconfig): 
    ClusterFsxLustreConfig
  [FsxOpenZfsConfig](#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxopenzfsconfig): 
    ClusterFsxOpenZfsConfig
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterinstancestorageconfig-properties"></a>

`EbsVolumeConfig`  <a name="cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig"></a>
Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to `/opt/sagemaker`.  
*Required*: No  
*Type*: [ClusterEbsVolumeConfig](aws-properties-sagemaker-cluster-clusterebsvolumeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FsxLustreConfig`  <a name="cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxlustreconfig"></a>
Defines the configuration for attaching an Amazon FSx for Lustre file system to the instances in the SageMaker HyperPod cluster instance group.  
*Required*: No  
*Type*: [ClusterFsxLustreConfig](aws-properties-sagemaker-cluster-clusterfsxlustreconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FsxOpenZfsConfig`  <a name="cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxopenzfsconfig"></a>
Defines the configuration for attaching an Amazon FSx for OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.  
*Required*: No  
*Type*: [ClusterFsxOpenZfsConfig](aws-properties-sagemaker-cluster-clusterfsxopenzfsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterKubernetesConfig
<a name="aws-properties-sagemaker-cluster-clusterkubernetesconfig"></a>

Kubernetes configuration that specifies labels and taints to be applied to cluster nodes in an instance group. 

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterkubernetesconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterkubernetesconfig-syntax.json"></a>

```
{
  "[Labels](#cfn-sagemaker-cluster-clusterkubernetesconfig-labels)" : {Key: Value, ...},
  "[Taints](#cfn-sagemaker-cluster-clusterkubernetesconfig-taints)" : [ ClusterKubernetesTaint, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterkubernetesconfig-syntax.yaml"></a>

```
  [Labels](#cfn-sagemaker-cluster-clusterkubernetesconfig-labels): 
    Key: Value
  [Taints](#cfn-sagemaker-cluster-clusterkubernetesconfig-taints): 
    - ClusterKubernetesTaint
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterkubernetesconfig-properties"></a>

`Labels`  <a name="cfn-sagemaker-cluster-clusterkubernetesconfig-labels"></a>
Key-value pairs of labels to be applied to cluster nodes.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^.+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Taints`  <a name="cfn-sagemaker-cluster-clusterkubernetesconfig-taints"></a>
List of taints to be applied to cluster nodes.  
*Required*: No  
*Type*: Array of [ClusterKubernetesTaint](aws-properties-sagemaker-cluster-clusterkubernetestaint.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterKubernetesTaint
<a name="aws-properties-sagemaker-cluster-clusterkubernetestaint"></a>

A Kubernetes taint that can be applied to cluster nodes.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterkubernetestaint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterkubernetestaint-syntax.json"></a>

```
{
  "[Effect](#cfn-sagemaker-cluster-clusterkubernetestaint-effect)" : String,
  "[Key](#cfn-sagemaker-cluster-clusterkubernetestaint-key)" : String,
  "[Value](#cfn-sagemaker-cluster-clusterkubernetestaint-value)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterkubernetestaint-syntax.yaml"></a>

```
  [Effect](#cfn-sagemaker-cluster-clusterkubernetestaint-effect): String
  [Key](#cfn-sagemaker-cluster-clusterkubernetestaint-key): String
  [Value](#cfn-sagemaker-cluster-clusterkubernetestaint-value): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterkubernetestaint-properties"></a>

`Effect`  <a name="cfn-sagemaker-cluster-clusterkubernetestaint-effect"></a>
The effect of the taint. Valid values are `NoSchedule`, `PreferNoSchedule`, and `NoExecute`.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `NoSchedule | PreferNoSchedule | NoExecute`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Key`  <a name="cfn-sagemaker-cluster-clusterkubernetestaint-key"></a>
The key of the taint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?`  
*Minimum*: `1`  
*Maximum*: `317`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-cluster-clusterkubernetestaint-value"></a>
The value of the taint.  
*Required*: No  
*Type*: String  
*Pattern*: `(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterLifeCycleConfig
<a name="aws-properties-sagemaker-cluster-clusterlifecycleconfig"></a>

The lifecycle configuration for a SageMaker HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterlifecycleconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterlifecycleconfig-syntax.json"></a>

```
{
  "[OnCreate](#cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate)" : String,
  "[OnInitComplete](#cfn-sagemaker-cluster-clusterlifecycleconfig-oninitcomplete)" : String,
  "[SourceS3Uri](#cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterlifecycleconfig-syntax.yaml"></a>

```
  [OnCreate](#cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate): String
  [OnInitComplete](#cfn-sagemaker-cluster-clusterlifecycleconfig-oninitcomplete): String
  [SourceS3Uri](#cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterlifecycleconfig-properties"></a>

`OnCreate`  <a name="cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate"></a>
The file name of the entrypoint script of lifecycle scripts under `SourceS3Uri`. This entrypoint script runs during cluster creation.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\S\s]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OnInitComplete`  <a name="cfn-sagemaker-cluster-clusterlifecycleconfig-oninitcomplete"></a>
The file name of the entrypoint script of lifecycle scripts under `SourceS3Uri`. This script runs on the node after the AMI-based initialization is complete.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\S\s]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceS3Uri`  <a name="cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri"></a>
An Amazon S3 bucket path where your lifecycle scripts are stored.  
Make sure that the S3 bucket path starts with `s3://sagemaker-`. The [IAM role for SageMaker HyperPod](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-iam-role-for-hyperpod) has the managed [https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html](https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html) attached, which allows access to S3 buckets with the specific prefix `sagemaker-`.
*Required*: No  
*Type*: String  
*Pattern*: `^(https|s3)://([^/]+)/?(.*)$`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterOrchestratorEksConfig
<a name="aws-properties-sagemaker-cluster-clusterorchestratoreksconfig"></a>

The configuration for the Amazon EKS cluster that is used as the orchestrator for the SageMaker HyperPod cluster. This includes the Amazon Resource Name (ARN) of the EKS cluster

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterorchestratoreksconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterorchestratoreksconfig-syntax.json"></a>

```
{
  "[ClusterArn](#cfn-sagemaker-cluster-clusterorchestratoreksconfig-clusterarn)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterorchestratoreksconfig-syntax.yaml"></a>

```
  [ClusterArn](#cfn-sagemaker-cluster-clusterorchestratoreksconfig-clusterarn): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterorchestratoreksconfig-properties"></a>

`ClusterArn`  <a name="cfn-sagemaker-cluster-clusterorchestratoreksconfig-clusterarn"></a>
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterOrchestratorSlurmConfig
<a name="aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig"></a>

The configuration settings for the Slurm orchestrator used with the SageMaker HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig-syntax.json"></a>

```
{
  "[SlurmConfigStrategy](#cfn-sagemaker-cluster-clusterorchestratorslurmconfig-slurmconfigstrategy)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig-syntax.yaml"></a>

```
  [SlurmConfigStrategy](#cfn-sagemaker-cluster-clusterorchestratorslurmconfig-slurmconfigstrategy): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig-properties"></a>

`SlurmConfigStrategy`  <a name="cfn-sagemaker-cluster-clusterorchestratorslurmconfig-slurmconfigstrategy"></a>
The strategy for managing partitions for the Slurm configuration. Valid values are `Managed`, `Overwrite`, and `Merge`.  
*Required*: No  
*Type*: String  
*Allowed values*: `Overwrite | Managed | Merge`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterRestrictedInstanceGroup
<a name="aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup"></a>

Specialized instance groups for training models like Amazon Nova in the SageMaker HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup-syntax.json"></a>

```
{
  "[CurrentCount](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-currentcount)" : Integer,
  "[EnvironmentConfig](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-environmentconfig)" : EnvironmentConfig,
  "[ExecutionRole](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-executionrole)" : String,
  "[InstanceCount](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancecount)" : Integer,
  "[InstanceGroupName](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancegroupname)" : String,
  "[InstanceStorageConfigs](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancestorageconfigs)" : [ ClusterInstanceStorageConfig, ... ],
  "[InstanceType](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancetype)" : String,
  "[OnStartDeepHealthChecks](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-onstartdeephealthchecks)" : [ String, ... ],
  "[OverrideVpcConfig](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-overridevpcconfig)" : VpcConfig,
  "[ThreadsPerCore](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-threadspercore)" : Integer,
  "[TrainingPlanArn](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-trainingplanarn)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup-syntax.yaml"></a>

```
  [CurrentCount](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-currentcount): Integer
  [EnvironmentConfig](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-environmentconfig): 
    EnvironmentConfig
  [ExecutionRole](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-executionrole): String
  [InstanceCount](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancecount): Integer
  [InstanceGroupName](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancegroupname): String
  [InstanceStorageConfigs](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancestorageconfigs): 
    - ClusterInstanceStorageConfig
  [InstanceType](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancetype): String
  [OnStartDeepHealthChecks](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-onstartdeephealthchecks): 
    - String
  [OverrideVpcConfig](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-overridevpcconfig): 
    VpcConfig
  [ThreadsPerCore](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-threadspercore): Integer
  [TrainingPlanArn](#cfn-sagemaker-cluster-clusterrestrictedinstancegroup-trainingplanarn): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterrestrictedinstancegroup-properties"></a>

`CurrentCount`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-currentcount"></a>
The current number of instances in the restricted instance group.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentConfig`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-environmentconfig"></a>
Environment configuration for the restricted instance group, including FSx Lustre settings.  
*Required*: Yes  
*Type*: [EnvironmentConfig](aws-properties-sagemaker-cluster-environmentconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRole`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-executionrole"></a>
The Amazon Resource Name (ARN) of the IAM execution role for the restricted instance group.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`InstanceCount`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancecount"></a>
The number of instances in the restricted instance group.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceGroupName`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancegroupname"></a>
The name of the restricted instance group.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`InstanceStorageConfigs`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancestorageconfigs"></a>
Storage configurations for instances in the restricted instance group.  
*Required*: No  
*Type*: Array of [ClusterInstanceStorageConfig](aws-properties-sagemaker-cluster-clusterinstancestorageconfig.md)  
*Maximum*: `4`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceType`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-instancetype"></a>
The EC2 instance type for the restricted instance group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OnStartDeepHealthChecks`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-onstartdeephealthchecks"></a>
Deep health checks to run when instances start in the restricted instance group.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OverrideVpcConfig`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-overridevpcconfig"></a>
VPC configuration override for the restricted instance group.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-sagemaker-cluster-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ThreadsPerCore`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-threadspercore"></a>
The number of threads per CPU core for instances in the restricted instance group.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TrainingPlanArn`  <a name="cfn-sagemaker-cluster-clusterrestrictedinstancegroup-trainingplanarn"></a>
The Amazon Resource Name (ARN) of the training plan for the restricted instance group.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*$`  
*Minimum*: `50`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ClusterSlurmConfig
<a name="aws-properties-sagemaker-cluster-clusterslurmconfig"></a>

The Slurm configuration for an instance group in a SageMaker HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-clusterslurmconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-clusterslurmconfig-syntax.json"></a>

```
{
  "[NodeType](#cfn-sagemaker-cluster-clusterslurmconfig-nodetype)" : String,
  "[PartitionNames](#cfn-sagemaker-cluster-clusterslurmconfig-partitionnames)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-clusterslurmconfig-syntax.yaml"></a>

```
  [NodeType](#cfn-sagemaker-cluster-clusterslurmconfig-nodetype): String
  [PartitionNames](#cfn-sagemaker-cluster-clusterslurmconfig-partitionnames): 
    - String
```

## Properties
<a name="aws-properties-sagemaker-cluster-clusterslurmconfig-properties"></a>

`NodeType`  <a name="cfn-sagemaker-cluster-clusterslurmconfig-nodetype"></a>
The type of Slurm node for the instance group. Valid values are `Controller`, `Worker`, and `Login`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Controller | Login | Compute`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PartitionNames`  <a name="cfn-sagemaker-cluster-clusterslurmconfig-partitionnames"></a>
The list of Slurm partition names that the instance group belongs to.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `0 | 0`  
*Maximum*: `1024 | 1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster DeploymentConfig
<a name="aws-properties-sagemaker-cluster-deploymentconfig"></a>

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

## Syntax
<a name="aws-properties-sagemaker-cluster-deploymentconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-deploymentconfig-syntax.json"></a>

```
{
  "[AutoRollbackConfiguration](#cfn-sagemaker-cluster-deploymentconfig-autorollbackconfiguration)" : [ AlarmDetails, ... ],
  "[RollingUpdatePolicy](#cfn-sagemaker-cluster-deploymentconfig-rollingupdatepolicy)" : RollingUpdatePolicy,
  "[WaitIntervalInSeconds](#cfn-sagemaker-cluster-deploymentconfig-waitintervalinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-deploymentconfig-syntax.yaml"></a>

```
  [AutoRollbackConfiguration](#cfn-sagemaker-cluster-deploymentconfig-autorollbackconfiguration): 
    - AlarmDetails
  [RollingUpdatePolicy](#cfn-sagemaker-cluster-deploymentconfig-rollingupdatepolicy): 
    RollingUpdatePolicy
  [WaitIntervalInSeconds](#cfn-sagemaker-cluster-deploymentconfig-waitintervalinseconds): Integer
```

## Properties
<a name="aws-properties-sagemaker-cluster-deploymentconfig-properties"></a>

`AutoRollbackConfiguration`  <a name="cfn-sagemaker-cluster-deploymentconfig-autorollbackconfiguration"></a>
Automatic rollback configuration for handling endpoint deployment failures and recovery.  
*Required*: No  
*Type*: Array of [AlarmDetails](aws-properties-sagemaker-cluster-alarmdetails.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RollingUpdatePolicy`  <a name="cfn-sagemaker-cluster-deploymentconfig-rollingupdatepolicy"></a>
Specifies a rolling deployment strategy for updating a SageMaker endpoint.  
*Required*: No  
*Type*: [RollingUpdatePolicy](aws-properties-sagemaker-cluster-rollingupdatepolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WaitIntervalInSeconds`  <a name="cfn-sagemaker-cluster-deploymentconfig-waitintervalinseconds"></a>
The wait interval in seconds between deployment batches.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `3600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster EnvironmentConfig
<a name="aws-properties-sagemaker-cluster-environmentconfig"></a>

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

## Syntax
<a name="aws-properties-sagemaker-cluster-environmentconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-environmentconfig-syntax.json"></a>

```
{
  "[FSxLustreConfig](#cfn-sagemaker-cluster-environmentconfig-fsxlustreconfig)" : FSxLustreConfig
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-environmentconfig-syntax.yaml"></a>

```
  [FSxLustreConfig](#cfn-sagemaker-cluster-environmentconfig-fsxlustreconfig): 
    FSxLustreConfig
```

## Properties
<a name="aws-properties-sagemaker-cluster-environmentconfig-properties"></a>

`FSxLustreConfig`  <a name="cfn-sagemaker-cluster-environmentconfig-fsxlustreconfig"></a>
Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.  
*Required*: No  
*Type*: [FSxLustreConfig](aws-properties-sagemaker-cluster-fsxlustreconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster FSxLustreConfig
<a name="aws-properties-sagemaker-cluster-fsxlustreconfig"></a>

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-fsxlustreconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-fsxlustreconfig-syntax.json"></a>

```
{
  "[PerUnitStorageThroughput](#cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput)" : Integer,
  "[SizeInGiB](#cfn-sagemaker-cluster-fsxlustreconfig-sizeingib)" : Integer
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-fsxlustreconfig-syntax.yaml"></a>

```
  [PerUnitStorageThroughput](#cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput): Integer
  [SizeInGiB](#cfn-sagemaker-cluster-fsxlustreconfig-sizeingib): Integer
```

## Properties
<a name="aws-properties-sagemaker-cluster-fsxlustreconfig-properties"></a>

`PerUnitStorageThroughput`  <a name="cfn-sagemaker-cluster-fsxlustreconfig-perunitstoragethroughput"></a>
The throughput capacity of the Amazon FSx for Lustre file system, measured in MB/s per TiB of storage.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `125`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizeInGiB`  <a name="cfn-sagemaker-cluster-fsxlustreconfig-sizeingib"></a>
The storage capacity of the Amazon FSx for Lustre file system, specified in gibibytes (GiB).  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1200`  
*Maximum*: `100800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster Orchestrator
<a name="aws-properties-sagemaker-cluster-orchestrator"></a>

The orchestrator for a SageMaker HyperPod cluster.

## Syntax
<a name="aws-properties-sagemaker-cluster-orchestrator-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-orchestrator-syntax.json"></a>

```
{
  "[Eks](#cfn-sagemaker-cluster-orchestrator-eks)" : ClusterOrchestratorEksConfig,
  "[Slurm](#cfn-sagemaker-cluster-orchestrator-slurm)" : ClusterOrchestratorSlurmConfig
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-orchestrator-syntax.yaml"></a>

```
  [Eks](#cfn-sagemaker-cluster-orchestrator-eks): 
    ClusterOrchestratorEksConfig
  [Slurm](#cfn-sagemaker-cluster-orchestrator-slurm): 
    ClusterOrchestratorSlurmConfig
```

## Properties
<a name="aws-properties-sagemaker-cluster-orchestrator-properties"></a>

`Eks`  <a name="cfn-sagemaker-cluster-orchestrator-eks"></a>
The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.  
*Required*: No  
*Type*: [ClusterOrchestratorEksConfig](aws-properties-sagemaker-cluster-clusterorchestratoreksconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Slurm`  <a name="cfn-sagemaker-cluster-orchestrator-slurm"></a>
Configuration for using Slurm as the cluster orchestrator.  
*Required*: No  
*Type*: [ClusterOrchestratorSlurmConfig](aws-properties-sagemaker-cluster-clusterorchestratorslurmconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster RollingUpdatePolicy
<a name="aws-properties-sagemaker-cluster-rollingupdatepolicy"></a>

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

## Syntax
<a name="aws-properties-sagemaker-cluster-rollingupdatepolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-rollingupdatepolicy-syntax.json"></a>

```
{
  "[MaximumBatchSize](#cfn-sagemaker-cluster-rollingupdatepolicy-maximumbatchsize)" : CapacitySizeConfig,
  "[RollbackMaximumBatchSize](#cfn-sagemaker-cluster-rollingupdatepolicy-rollbackmaximumbatchsize)" : CapacitySizeConfig
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-rollingupdatepolicy-syntax.yaml"></a>

```
  [MaximumBatchSize](#cfn-sagemaker-cluster-rollingupdatepolicy-maximumbatchsize): 
    CapacitySizeConfig
  [RollbackMaximumBatchSize](#cfn-sagemaker-cluster-rollingupdatepolicy-rollbackmaximumbatchsize): 
    CapacitySizeConfig
```

## Properties
<a name="aws-properties-sagemaker-cluster-rollingupdatepolicy-properties"></a>

`MaximumBatchSize`  <a name="cfn-sagemaker-cluster-rollingupdatepolicy-maximumbatchsize"></a>
Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.  
*Required*: Yes  
*Type*: [CapacitySizeConfig](aws-properties-sagemaker-cluster-capacitysizeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RollbackMaximumBatchSize`  <a name="cfn-sagemaker-cluster-rollingupdatepolicy-rollbackmaximumbatchsize"></a>
Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.  
*Required*: No  
*Type*: [CapacitySizeConfig](aws-properties-sagemaker-cluster-capacitysizeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster ScheduledUpdateConfig
<a name="aws-properties-sagemaker-cluster-scheduledupdateconfig"></a>

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

## Syntax
<a name="aws-properties-sagemaker-cluster-scheduledupdateconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-scheduledupdateconfig-syntax.json"></a>

```
{
  "[DeploymentConfig](#cfn-sagemaker-cluster-scheduledupdateconfig-deploymentconfig)" : DeploymentConfig,
  "[ScheduleExpression](#cfn-sagemaker-cluster-scheduledupdateconfig-scheduleexpression)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-scheduledupdateconfig-syntax.yaml"></a>

```
  [DeploymentConfig](#cfn-sagemaker-cluster-scheduledupdateconfig-deploymentconfig): 
    DeploymentConfig
  [ScheduleExpression](#cfn-sagemaker-cluster-scheduledupdateconfig-scheduleexpression): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-scheduledupdateconfig-properties"></a>

`DeploymentConfig`  <a name="cfn-sagemaker-cluster-scheduledupdateconfig-deploymentconfig"></a>
The configuration to use when updating the AMI versions.  
*Required*: No  
*Type*: [DeploymentConfig](aws-properties-sagemaker-cluster-deploymentconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScheduleExpression`  <a name="cfn-sagemaker-cluster-scheduledupdateconfig-scheduleexpression"></a>
A cron expression that specifies the schedule that SageMaker follows when updating the AMI.  
*Required*: Yes  
*Type*: String  
*Pattern*: `cron\((?:[0-5][0-9]|[0-9]|) (?:[01][0-9]|2[0-3]|[0-9]) (?:[1-9]|0[1-9]|[12][0-9]|3[01]|\?) (?:[1-9]|0[1-9]|1[0-2]|\*|\*/(?:[1-9]|1[0-2])|) (?:MON|TUE|WED|THU|FRI|SAT|SUN|[1-7]|\?|L|(?:[1-7]#[1-5])|(?:[1-7]L)) (?:20[2-9][0-9]|\*|)\)`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster Tag
<a name="aws-properties-sagemaker-cluster-tag"></a>

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your AWS resources with tagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing AWS resources with tagging, see [Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).

## Syntax
<a name="aws-properties-sagemaker-cluster-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-tag-syntax.json"></a>

```
{
  "[Key](#cfn-sagemaker-cluster-tag-key)" : String,
  "[Value](#cfn-sagemaker-cluster-tag-value)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-tag-syntax.yaml"></a>

```
  [Key](#cfn-sagemaker-cluster-tag-key): String
  [Value](#cfn-sagemaker-cluster-tag-value): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-tag-properties"></a>

`Key`  <a name="cfn-sagemaker-cluster-tag-key"></a>
The tag key. Tag keys must be unique per resource.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-cluster-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster TieredStorageConfig
<a name="aws-properties-sagemaker-cluster-tieredstorageconfig"></a>

Defines the configuration for managed tier checkpointing in a HyperPod cluster. Managed tier checkpointing uses multiple storage tiers, including cluster CPU memory, to provide faster checkpoint operations and improved fault tolerance for large-scale model training. The system automatically saves checkpoints at high frequency to memory and periodically persists them to durable storage, like Amazon S3.

## Syntax
<a name="aws-properties-sagemaker-cluster-tieredstorageconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-tieredstorageconfig-syntax.json"></a>

```
{
  "[InstanceMemoryAllocationPercentage](#cfn-sagemaker-cluster-tieredstorageconfig-instancememoryallocationpercentage)" : Integer,
  "[Mode](#cfn-sagemaker-cluster-tieredstorageconfig-mode)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-tieredstorageconfig-syntax.yaml"></a>

```
  [InstanceMemoryAllocationPercentage](#cfn-sagemaker-cluster-tieredstorageconfig-instancememoryallocationpercentage): Integer
  [Mode](#cfn-sagemaker-cluster-tieredstorageconfig-mode): String
```

## Properties
<a name="aws-properties-sagemaker-cluster-tieredstorageconfig-properties"></a>

`InstanceMemoryAllocationPercentage`  <a name="cfn-sagemaker-cluster-tieredstorageconfig-instancememoryallocationpercentage"></a>
The percentage (int) of cluster memory to allocate for checkpointing.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mode`  <a name="cfn-sagemaker-cluster-tieredstorageconfig-mode"></a>
Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to `Enable`, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to `Disable`, the feature is turned off and the memory management daemon is removed from the cluster.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Enable | Disable`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::Cluster VpcConfig
<a name="aws-properties-sagemaker-cluster-vpcconfig"></a>

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](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). 

## Syntax
<a name="aws-properties-sagemaker-cluster-vpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-cluster-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-sagemaker-cluster-vpcconfig-securitygroupids)" : [ String, ... ],
  "[Subnets](#cfn-sagemaker-cluster-vpcconfig-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-cluster-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-sagemaker-cluster-vpcconfig-securitygroupids): 
    - String
  [Subnets](#cfn-sagemaker-cluster-vpcconfig-subnets): 
    - String
```

## Properties
<a name="aws-properties-sagemaker-cluster-vpcconfig-properties"></a>

`SecurityGroupIds`  <a name="cfn-sagemaker-cluster-vpcconfig-securitygroupids"></a>
The VPC security group IDs, in the form `sg-xxxxxxxx`. Specify the security groups for the VPC that is specified in the `Subnets` field.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `32 | 5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Subnets`  <a name="cfn-sagemaker-cluster-vpcconfig-subnets"></a>
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html).  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `32 | 16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)