DATASOURCE::ECS::HpcCluster - Resource Orchestration Service

DATASOURCE::ECS::HpcCluster is used to query a High Performance Computing (HPC) cluster.

Syntax

{
  "Type": "DATASOURCE::ECS::HpcCluster",
  "Properties": {
    "HpcClusterId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

HpcClusterId

String

Yes

The ID of the HPC cluster.

None.

RefreshOptions

String

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

Description: the description of the HPC cluster.
HpcClusterId: the ID of the HPC cluster.
HpcClusterName: the name of the HPC cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HpcClusterId:
    Type: String
    Description:
      en: The ID of cluster.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ECS::HpcCluster
    Properties:
      HpcClusterId:
        Ref: HpcClusterId
Outputs:
  Description:
    Description: The description of the HPC cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  HpcClusterId:
    Description: The ID of cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HpcClusterId
  HpcClusterName:
    Description: The name of the HPC cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HpcClusterName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HpcClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of cluster."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::HpcCluster",
      "Properties": {
        "HpcClusterId": {
          "Ref": "HpcClusterId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the HPC cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "HpcClusterId": {
      "Description": "The ID of cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HpcClusterId"
        ]
      }
    },
    "HpcClusterName": {
      "Description": "The name of the HPC cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HpcClusterName"
        ]
      }
    }
  }
}