All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ECS::HpcClusters

Last Updated:Oct 28, 2024

DATASOURCE::ECS::HpcClusters is used to query available High Performance Computing (HPC) clusters.

Syntax

{
  "Type": "DATASOURCE::ECS::HpcClusters",
  "Properties": {
    "HpcClusterIds": List,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

HpcClusterIds

List

No

Yes

The IDs of the HPC clusters.

You can specify up to 100 cluster IDs. Separate multiple IDs with commas (,).

Example: ["hpc-pnlg1ds9rky4****", "hpc-cxvr5uzy54j0ya****"].

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): does not refresh data source resources when the stack is updated.

  • Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

  • HpcClusterIds: the IDs of the HPC clusters.

  • HpcClusters: the details of the HPC clusters.

Property

Type

Description

Constraint

HpcClusterIds

List

The IDs of the HPC clusters.

Example: ["hpc-pnlg1ds9rky4****", "hpc-cxvr5uzy54j0ya****"].

HpcClusters

List

The details of the HPC clusters.

None.

HpcClusterId

String

The ID of the HPC cluster.

Example: hpc-pnlg1ds9rky4****.

Name

String

The name of the HPC cluster.

None.

Description

String

The description of the HPC cluster.

None.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HpcClusterIds": {
      "Type": "Json",
      "Description": "The IDs of the HPC clusters. You can specify up to 100 HPC cluster IDs.",
      "MaxLength": 100,
      "Default": ["hpc-bp1a5zr3u7nq9cx****"]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::HpcClusters",
      "Properties": {
        "HpcClusterIds": {
          "Ref": "HpcClusterIds"
        }
      }
    }
  },
  "Outputs": {
    "HpcClusters": {
      "Description": "The list of hpc clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HpcClusters"
        ]
      }
    },
    "HpcClusterIds": {
      "Description": "the list of hpc cluster ids",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HpcClusterIds"
        ]
      }
    }
  }
}