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

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.getCluster

Explore with Pulumi AI

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

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
Copy
def get_cluster(cluster_arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:sagemaker:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterArn This property is required. string
The Amazon Resource Name (ARN) of the HyperPod Cluster.
ClusterArn This property is required. string
The Amazon Resource Name (ARN) of the HyperPod Cluster.
clusterArn This property is required. String
The Amazon Resource Name (ARN) of the HyperPod Cluster.
clusterArn This property is required. string
The Amazon Resource Name (ARN) of the HyperPod Cluster.
cluster_arn This property is required. str
The Amazon Resource Name (ARN) of the HyperPod Cluster.
clusterArn This property is required. String
The Amazon Resource Name (ARN) of the HyperPod Cluster.

getCluster Result

The following output properties are available:

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.
InstanceGroups List<Pulumi.AwsNative.SageMaker.Outputs.ClusterInstanceGroup>
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
Tags List<Pulumi.AwsNative.Outputs.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.
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.
InstanceGroups []ClusterInstanceGroup
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
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.
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.
instanceGroups List<ClusterInstanceGroup>
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
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.
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.
instanceGroups ClusterInstanceGroup[]
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
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.
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.
instance_groups Sequence[ClusterInstanceGroup]
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
tags Sequence[root_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.
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.
instanceGroups List<Property Map>
The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
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.
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.

Supporting Types

ClusterDeepHealthCheckType

ClusterInstanceGroup

ExecutionRole
This property is required.
Changes to this property will trigger replacement.
string
InstanceCount This property is required. int
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
InstanceGroupName
This property is required.
Changes to this property will trigger replacement.
string
InstanceType
This property is required.
Changes to this property will trigger replacement.
string
LifeCycleConfig This property is required. 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 Changes to this property will trigger replacement. Pulumi.AwsNative.SageMaker.Inputs.ClusterVpcConfig
ThreadsPerCore Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
InstanceCount This property is required. int
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
InstanceGroupName
This property is required.
Changes to this property will trigger replacement.
string
InstanceType
This property is required.
Changes to this property will trigger replacement.
string
LifeCycleConfig This property is required. ClusterLifeCycleConfig
CurrentCount int
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
InstanceStorageConfigs []ClusterInstanceStorageConfig
OnStartDeepHealthChecks []ClusterDeepHealthCheckType
OverrideVpcConfig Changes to this property will trigger replacement. ClusterVpcConfig
ThreadsPerCore Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
instanceCount This property is required. Integer
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
instanceGroupName
This property is required.
Changes to this property will trigger replacement.
String
instanceType
This property is required.
Changes to this property will trigger replacement.
String
lifeCycleConfig This property is required. 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 Changes to this property will trigger replacement. ClusterVpcConfig
threadsPerCore Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
string
instanceCount This property is required. number
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
instanceGroupName
This property is required.
Changes to this property will trigger replacement.
string
instanceType
This property is required.
Changes to this property will trigger replacement.
string
lifeCycleConfig This property is required. ClusterLifeCycleConfig
currentCount number
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
instanceStorageConfigs ClusterInstanceStorageConfig[]
onStartDeepHealthChecks ClusterDeepHealthCheckType[]
overrideVpcConfig Changes to this property will trigger replacement. ClusterVpcConfig
threadsPerCore Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
str
instance_count This property is required. int
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
instance_group_name
This property is required.
Changes to this property will trigger replacement.
str
instance_type
This property is required.
Changes to this property will trigger replacement.
str
life_cycle_config This property is required. 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 Changes to this property will trigger replacement. ClusterVpcConfig
threads_per_core Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
String
instanceCount This property is required. Number
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
instanceGroupName
This property is required.
Changes to this property will trigger replacement.
String
instanceType
This property is required.
Changes to this property will trigger replacement.
String
lifeCycleConfig This property is required. 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 Changes to this property will trigger replacement. Property Map
threadsPerCore Changes to this property will trigger replacement. 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

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

ClusterNodeRecovery

ClusterStatus

ClusterVpcConfig

SecurityGroupIds This property is required. 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 This property is required. List<string>
The ID of the subnets in the VPC to which you want to connect your training job or model.
SecurityGroupIds This property is required. []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 This property is required. []string
The ID of the subnets in the VPC to which you want to connect your training job or model.
securityGroupIds This property is required. 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 This property is required. List<String>
The ID of the subnets in the VPC to which you want to connect your training job or model.
securityGroupIds This property is required. 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 This property is required. string[]
The ID of the subnets in the VPC to which you want to connect your training job or model.
security_group_ids This property is required. 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 This property is required. Sequence[str]
The ID of the subnets in the VPC to which you want to connect your training job or model.
securityGroupIds This property is required. 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 This property is required. List<String>
The ID of the subnets in the VPC to which you want to connect your training job or model.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

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