DATASOURCE::ECS::DedicatedHostCluster - Resource Orchestration Service

DATASOURCE::ECS::DedicatedHostCluster is used to query the information about a dedicated host cluster.

Syntax

{
  "Type": "DATASOURCE::ECS::DedicatedHostCluster",
  "Properties": {
    "DedicatedHostClusterId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DedicatedHostClusterId

String

Yes

The ID of the dedicated host 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 dedicated host cluster.
ZoneId: the zone ID of the dedicated host cluster.
DedicatedHostClusterName: the name of the dedicated host cluster.
ResourceGroupId: the resource group ID of the dedicated host cluster.
Tags: the tags of the dedicated host cluster.
DedicatedHostClusterId: the ID of the dedicated host cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DedicatedHostClusterId:
    Type: String
    Description:
      en: Dedicated host cluster id.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ECS::DedicatedHostCluster
    Properties:
      DedicatedHostClusterId:
        Ref: DedicatedHostClusterId
Outputs:
  Description:
    Description: The description of the dedicated host cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ZoneId:
    Description: 'The zone ID of the dedicated host cluster. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  DedicatedHostClusterName:
    Description: The name of the dedicated host cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedHostClusterName
  ResourceGroupId:
    Description: 'The ID of the resource group to which the dedicated host cluster belongs. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  Tags:
    Description: The tags of the dedicated host cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  DedicatedHostClusterId:
    Description: Dedicated host cluster id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedHostClusterId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DedicatedHostClusterId": {
      "Type": "String",
      "Description": {
        "en": "Dedicated host cluster id."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::DedicatedHostCluster",
      "Properties": {
        "DedicatedHostClusterId": {
          "Ref": "DedicatedHostClusterId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the dedicated host cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID of the dedicated host cluster. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "DedicatedHostClusterName": {
      "Description": "The name of the dedicated host cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedHostClusterName"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group to which the dedicated host cluster belongs. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the dedicated host cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "DedicatedHostClusterId": {
      "Description": "Dedicated host cluster id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedHostClusterId"
        ]
      }
    }
  }
}