All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ECS::DedicatedHostClusters

Last Updated:Oct 24, 2024

DATASOURCE::ECS::DedicatedHostClusters is used to query the information about dedicated host clusters.

Syntax

{
  "Type": "DATASOURCE::ECS::DedicatedHostClusters",
  "Properties": {
    "DedicatedHostClusterName": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "RefreshOptions": 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 ID of the resource group to which the dedicated host cluster belongs.

None.

ZoneId

String

No

Yes

The ID of the zone in which the dedicated host cluster resides.

None.

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

  • DedicatedHostClusters: the information about 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

The information about dedicated host clusters.

None

Description

String

The description of the dedicated host cluster.

None

Tags

String

The tags of the dedicated host cluster.

None

ZoneId

String

The ID of the zone in which the dedicated host cluster resides.

None

DedicatedHostClusterName

String

The name of the dedicated host cluster.

None

ResourceGroupId

String

The ID of the resource group to which the dedicated host cluster belongs.

None

DedicatedHostClusterId

String

The ID of the dedicated host cluster.

None

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Description: |-
      The zone ID of the dedicated host cluster. 
      You can call the DescribeZones operation to query the most recent zone list.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ECS::DedicatedHostClusters
    Properties:
      ZoneId:
        Ref: ZoneId
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

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Description": "The zone ID of the dedicated host cluster. \nYou can call the DescribeZones operation to query the most recent zone list."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::DedicatedHostClusters",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        }
      }
    }
  },
  "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"
        ]
      }
    }
  }
}