Docs Home Pulumi IaC Pulumi ESC 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

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

    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>
    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]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > 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)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:sagemaker:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    ClusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterArn String
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterArn string
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    cluster_arn str
    The Amazon Resource Name (ARN) of the HyperPod Cluster.
    clusterArn 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 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

    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

    ClusterStatus

    ClusterVpcConfig

    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

    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