DATASOURCE::ECS::DedicatedHostClusters

Updated at:

Queries basic information about dedicated host clusters.

Syntax

{
  "Type": "DATASOURCE::ECS::DedicatedHostClusters",
  "Properties": {
    "DedicatedHostClusterName": String,
    "ResourceGroupId": String,
    "ZoneId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DedicatedHostClusterName

String

No

Yes

The name of the dedicated host cluster.

None.

ResourceGroupId

String

No

Yes

The resource group ID of the dedicated host cluster.

None.

ZoneId

String

No

Yes

The zone ID of the dedicated host cluster.

None.

Return values

Fn::GetAtt

  • DedicatedHostClusters: details of the dedicated host clusters.

  • DedicatedHostClusterIds: the IDs of the dedicated host clusters.

Property

Type

Description

Constraint

DedicatedHostClusterIds

List

The IDs of dedicated host clusters.

None.

DedicatedHostClusters

List

Details of the dedicated host clusters.

None.

DedicatedHostClusterName

String

The name of the dedicated host cluster.

None.

DedicatedHostClusterId

String

The ID of the dedicated host cluster.

None.

ZoneId

String

The zone ID of the dedicated host cluster.

None.

Description

String

The description of the dedicated host cluster.

None.

Tags

List

The tags of the dedicated host cluster.

None.

ResourceGroupId

String

The resource group ID of the dedicated host cluster.

None.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DedicatedHostClusterName:
    Description: The name of the dedicated host cluster.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DedicatedHostClusterName:
        Ref: DedicatedHostClusterName
    Type: DATASOURCE::ECS::DedicatedHostClusters
Outputs:
  DedicatedHostClusterIds:
    Description: The list of dedicated host cluster IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DedicatedHostClusterIds
  DedicatedHostClusters:
    Description: The list of dedicated host clusters.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DedicatedHostClusters

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DedicatedHostClusterName": {
      "Type": "String",
      "Description": "The name of the dedicated host cluster."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::DedicatedHostClusters",
      "Properties": {
        "DedicatedHostClusterName": {
          "Ref": "DedicatedHostClusterName"
        }
      }
    }
  },
  "Outputs": {
    "DedicatedHostClusters": {
      "Description": "The list of dedicated host clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedHostClusters"
        ]
      }
    },
    "DedicatedHostClusterIds": {
      "Description": "The list of dedicated host cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedHostClusterIds"
        ]
      }
    }
  }
}