Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. Cluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.Cluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::Cluster

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            instance_groups: Optional[Sequence[ClusterInstanceGroupArgs]] = None,
            cluster_name: Optional[str] = None,
            node_recovery: Optional[ClusterNodeRecovery] = None,
            orchestrator: Optional[ClusterOrchestratorArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
            vpc_config: Optional[ClusterVpcConfigArgs] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws-native:sagemaker:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    InstanceGroups List<Pulumi.AwsNative.SageMaker.Inputs.ClusterInstanceGroup>
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    ClusterName string
    The name of the HyperPod Cluster.
    NodeRecovery Pulumi.AwsNative.SageMaker.ClusterNodeRecovery
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    Orchestrator Pulumi.AwsNative.SageMaker.Inputs.ClusterOrchestrator
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    VpcConfig Pulumi.AwsNative.SageMaker.Inputs.ClusterVpcConfig
    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 .
    InstanceGroups []ClusterInstanceGroupArgs
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    ClusterName string
    The name of the HyperPod Cluster.
    NodeRecovery ClusterNodeRecovery
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    Orchestrator ClusterOrchestratorArgs
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    Tags TagArgs
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    VpcConfig ClusterVpcConfigArgs
    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 .
    instanceGroups List<ClusterInstanceGroup>
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    clusterName String
    The name of the HyperPod Cluster.
    nodeRecovery ClusterNodeRecovery
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    orchestrator ClusterOrchestrator
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    tags List<Tag>
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    vpcConfig ClusterVpcConfig
    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 .
    instanceGroups ClusterInstanceGroup[]
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    clusterName string
    The name of the HyperPod Cluster.
    nodeRecovery ClusterNodeRecovery
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    orchestrator ClusterOrchestrator
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    tags Tag[]
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    vpcConfig ClusterVpcConfig
    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 .
    instance_groups Sequence[ClusterInstanceGroupArgs]
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    cluster_name str
    The name of the HyperPod Cluster.
    node_recovery ClusterNodeRecovery
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    orchestrator ClusterOrchestratorArgs
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    tags Sequence[TagArgs]
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    vpc_config ClusterVpcConfigArgs
    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 .
    instanceGroups List<Property Map>
    The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
    clusterName String
    The name of the HyperPod Cluster.
    nodeRecovery "Automatic" | "None"
    If node auto-recovery is set to true, faulty nodes will be replaced or rebooted when a failure is detected. If set to false, nodes will be labelled when a fault is detected.
    orchestrator Property Map
    The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
    tags List<Property Map>
    Custom tags for managing the SageMaker HyperPod cluster as an AWS resource. You can add tags to your cluster in the same way you add them in other AWS services that support tagging.
    vpcConfig Property Map
    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 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    ClusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    ClusterStatus Pulumi.AwsNative.SageMaker.ClusterStatus
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    ClusterStatus ClusterStatus
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterArn String
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterStatus ClusterStatus
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    clusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterStatus ClusterStatus
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_arn str
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    cluster_status ClusterStatus
    The status of the HyperPod Cluster.
    creation_time str
    The time at which the HyperPod cluster was created.
    failure_message str
    The failure message of the HyperPod Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    clusterArn String
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterStatus "Creating" | "Deleting" | "Failed" | "InService" | "RollingBack" | "SystemUpdating" | "Updating"
    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.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ClusterDeepHealthCheckType, ClusterDeepHealthCheckTypeArgs

    InstanceStress
    InstanceStress
    InstanceConnectivity
    InstanceConnectivity
    ClusterDeepHealthCheckTypeInstanceStress
    InstanceStress
    ClusterDeepHealthCheckTypeInstanceConnectivity
    InstanceConnectivity
    InstanceStress
    InstanceStress
    InstanceConnectivity
    InstanceConnectivity
    InstanceStress
    InstanceStress
    InstanceConnectivity
    InstanceConnectivity
    INSTANCE_STRESS
    InstanceStress
    INSTANCE_CONNECTIVITY
    InstanceConnectivity
    "InstanceStress"
    InstanceStress
    "InstanceConnectivity"
    InstanceConnectivity

    ClusterInstanceGroup, ClusterInstanceGroupArgs

    ExecutionRole string
    InstanceCount int
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    InstanceGroupName string
    InstanceType string
    LifeCycleConfig Pulumi.AwsNative.SageMaker.Inputs.ClusterLifeCycleConfig
    CurrentCount int
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    InstanceStorageConfigs List<Pulumi.AwsNative.SageMaker.Inputs.ClusterInstanceStorageConfig>
    OnStartDeepHealthChecks List<Pulumi.AwsNative.SageMaker.ClusterDeepHealthCheckType>
    OverrideVpcConfig Pulumi.AwsNative.SageMaker.Inputs.ClusterVpcConfig
    ThreadsPerCore int
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
    ExecutionRole string
    InstanceCount int
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    InstanceGroupName string
    InstanceType string
    LifeCycleConfig ClusterLifeCycleConfig
    CurrentCount int
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    InstanceStorageConfigs []ClusterInstanceStorageConfig
    OnStartDeepHealthChecks []ClusterDeepHealthCheckType
    OverrideVpcConfig ClusterVpcConfig
    ThreadsPerCore int
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
    executionRole String
    instanceCount Integer
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    instanceGroupName String
    instanceType String
    lifeCycleConfig ClusterLifeCycleConfig
    currentCount Integer
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    instanceStorageConfigs List<ClusterInstanceStorageConfig>
    onStartDeepHealthChecks List<ClusterDeepHealthCheckType>
    overrideVpcConfig ClusterVpcConfig
    threadsPerCore Integer
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
    executionRole string
    instanceCount number
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    instanceGroupName string
    instanceType string
    lifeCycleConfig ClusterLifeCycleConfig
    currentCount number
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    instanceStorageConfigs ClusterInstanceStorageConfig[]
    onStartDeepHealthChecks ClusterDeepHealthCheckType[]
    overrideVpcConfig ClusterVpcConfig
    threadsPerCore number
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
    execution_role str
    instance_count int
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    instance_group_name str
    instance_type str
    life_cycle_config ClusterLifeCycleConfig
    current_count int
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    instance_storage_configs Sequence[ClusterInstanceStorageConfig]
    on_start_deep_health_checks Sequence[ClusterDeepHealthCheckType]
    override_vpc_config ClusterVpcConfig
    threads_per_core int
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.
    executionRole String
    instanceCount Number
    The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
    instanceGroupName String
    instanceType String
    lifeCycleConfig Property Map
    currentCount Number
    The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
    instanceStorageConfigs List<Property Map>
    onStartDeepHealthChecks List<"InstanceStress" | "InstanceConnectivity">
    overrideVpcConfig Property Map
    threadsPerCore Number
    The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading.

    ClusterLifeCycleConfig, ClusterLifeCycleConfigArgs

    OnCreate string
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    SourceS3Uri string
    An Amazon S3 bucket path where your lifecycle scripts are stored.
    OnCreate string
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    SourceS3Uri string
    An Amazon S3 bucket path where your lifecycle scripts are stored.
    onCreate String
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    sourceS3Uri String
    An Amazon S3 bucket path where your lifecycle scripts are stored.
    onCreate string
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    sourceS3Uri string
    An Amazon S3 bucket path where your lifecycle scripts are stored.
    on_create str
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    source_s3_uri str
    An Amazon S3 bucket path where your lifecycle scripts are stored.
    onCreate String
    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
    sourceS3Uri String
    An Amazon S3 bucket path where your lifecycle scripts are stored.

    ClusterNodeRecovery, ClusterNodeRecoveryArgs

    Automatic
    Automatic
    None
    None
    ClusterNodeRecoveryAutomatic
    Automatic
    ClusterNodeRecoveryNone
    None
    Automatic
    Automatic
    None
    None
    Automatic
    Automatic
    None
    None
    AUTOMATIC
    Automatic
    NONE
    None
    "Automatic"
    Automatic
    "None"
    None

    ClusterOrchestrator, ClusterOrchestratorArgs

    Eks Pulumi.AwsNative.SageMaker.Inputs.ClusterOrchestratorEksConfig
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.
    Eks ClusterOrchestratorEksConfig
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.
    eks ClusterOrchestratorEksConfig
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.
    eks ClusterOrchestratorEksConfig
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.
    eks ClusterOrchestratorEksConfig
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.
    eks Property Map
    The configuration of the Amazon EKS orchestrator cluster for the SageMaker HyperPod cluster.

    ClusterOrchestratorEksConfig, ClusterOrchestratorEksConfigArgs

    ClusterArn string
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
    ClusterArn string
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
    clusterArn String
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
    clusterArn string
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
    cluster_arn str
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster
    clusterArn String
    The ARN of the EKS cluster, such as arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster

    ClusterStatus, ClusterStatusArgs

    Creating
    Creating
    Deleting
    Deleting
    Failed
    Failed
    InService
    InService
    RollingBack
    RollingBack
    SystemUpdating
    SystemUpdating
    Updating
    Updating
    ClusterStatusCreating
    Creating
    ClusterStatusDeleting
    Deleting
    ClusterStatusFailed
    Failed
    ClusterStatusInService
    InService
    ClusterStatusRollingBack
    RollingBack
    ClusterStatusSystemUpdating
    SystemUpdating
    ClusterStatusUpdating
    Updating
    Creating
    Creating
    Deleting
    Deleting
    Failed
    Failed
    InService
    InService
    RollingBack
    RollingBack
    SystemUpdating
    SystemUpdating
    Updating
    Updating
    Creating
    Creating
    Deleting
    Deleting
    Failed
    Failed
    InService
    InService
    RollingBack
    RollingBack
    SystemUpdating
    SystemUpdating
    Updating
    Updating
    CREATING
    Creating
    DELETING
    Deleting
    FAILED
    Failed
    IN_SERVICE
    InService
    ROLLING_BACK
    RollingBack
    SYSTEM_UPDATING
    SystemUpdating
    UPDATING
    Updating
    "Creating"
    Creating
    "Deleting"
    Deleting
    "Failed"
    Failed
    "InService"
    InService
    "RollingBack"
    RollingBack
    "SystemUpdating"
    SystemUpdating
    "Updating"
    Updating

    ClusterVpcConfig, ClusterVpcConfigArgs

    SecurityGroupIds List<string>
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    Subnets List<string>
    The ID of the subnets in the VPC to which you want to connect your training job or model.
    SecurityGroupIds []string
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    Subnets []string
    The ID of the subnets in the VPC to which you want to connect your training job or model.
    securityGroupIds List<String>
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    subnets List<String>
    The ID of the subnets in the VPC to which you want to connect your training job or model.
    securityGroupIds string[]
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    subnets string[]
    The ID of the subnets in the VPC to which you want to connect your training job or model.
    security_group_ids Sequence[str]
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    subnets Sequence[str]
    The ID of the subnets in the VPC to which you want to connect your training job or model.
    securityGroupIds List<String>
    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
    subnets List<String>
    The ID of the subnets in the VPC to which you want to connect your training job or model.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native