AWS::SageMaker::Cluster

SageMaker Cluster

Resource Type definition for AWS::SageMaker::Cluster

Properties

11 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AutoScaling`	`ClusterAutoScalingConfig`
`ClusterName`	`string`	Create-only
`ClusterRole`	`string`
`InstanceGroups`	`array`
`NodeProvisioningMode`	`string`
`NodeRecovery`	`string`
`Orchestrator`	`Orchestrator`
`RestrictedInstanceGroups`	`array`
`Tags`	`Array<Tag>`
`TieredStorageConfig`	`TieredStorageConfig`
`VpcConfig`	`VpcConfig`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ClusterArn`	`string`	The Amazon Resource Name (ARN) of the HyperPod Cluster.
`ClusterStatus`	`string`	The status of the HyperPod Cluster.
`CreationTime`	`string`	The time at which the HyperPod cluster was created.
`FailureMessage`	`string`	The failure message of the HyperPod Cluster.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SageMaker::Cluster

Resources:
  MyResource:
    Type: AWS::SageMaker::Cluster
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

sagemaker:DescribeClustersagemaker:ListTags

create

sagemaker:CreateClustersagemaker:DescribeClustersagemaker:UpdateClusterSoftwaresagemaker:AddTagssagemaker:ListTagssagemaker:BatchAddClusterNodessagemaker:BatchDeleteClusterNodeseks:DescribeAccessEntry

update

sagemaker:UpdateClustersagemaker:UpdateClusterSoftwaresagemaker:DescribeClustersagemaker:ListTagssagemaker:AddTagssagemaker:DeleteTagssagemaker:BatchAddClusterNodessagemaker:BatchDeleteClusterNodes

list

sagemaker:ListClusters

delete

sagemaker:DeleteClustersagemaker:DescribeClustereks:DescribeAccessEntryeks:DeleteAccessEntry

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSageMaker

Properties15

Required0

TaggingSupported

Primary IDClusterArn

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ClusterNameVpcConfigOrchestrator/EksInstanceGroups/*/OverrideVpcConfigInstanceGroups/*/ExecutionRoleInstanceGroups/*/InstanceGroupNameInstanceGroups/*/InstanceTypeInstanceGroups/*/ThreadsPerCoreRestrictedInstanceGroups/*/OverrideVpcConfigRestrictedInstanceGroups/*/ExecutionRoleRestrictedInstanceGroups/*/InstanceGroupNameRestrictedInstanceGroups/*/InstanceTypeRestrictedInstanceGroups/*/ThreadsPerCore

Related Resources

External Links

AWS Documentation