DATASOURCE::EBS::DedicatedBlockStorageClusters - Resource Orchestration Service

DATASOURCE::EBS::DedicatedBlockStorageClusters is used to query dedicated block storage clusters.

Syntax

{
  "Type": "DATASOURCE::EBS::DedicatedBlockStorageClusters",
  "Properties": {
    "DedicatedBlockStorageClusterId": String,
    "ResourceGroupId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DedicatedBlockStorageClusterId	String	No	Yes	The ID of the dedicated block storage cluster.	None.
ResourceGroupId	String	No	Yes	The ID of the resource group to which the dedicated block storage cluster belongs.	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

DedicatedBlockStorageClusters: details of the dedicated block storage clusters.
DedicatedBlockStorageClusterIds: the IDs of the dedicated block storage clusters.

Property	Type	Description	Constraint
DedicatedBlockStorageClusterIds	List	The IDs of the dedicated block storage clusters.	None.
DedicatedBlockStorageClusters	List	Details of the dedicated block storage clusters.	None.
Category	String	The category of cloud disks that can be created in the dedicated block storage cluster.	None.
DedicatedBlockStorageClusterName	String	The name of the dedicated block storage cluster.	None.
Description	String	The description of the dedicated block storage cluster.	None.
Tags	String	The tags that are added to the dedicated block storage cluster.	None.
Type	String	The type of the dedicated block storage cluster.	None.
DedicatedBlockStorageClusterId	String	The ID of the dedicated block storage cluster.	None.
ZoneId	String	The zone ID of the dedicated block storage cluster.	None.
ResourceGroupId	String	The ID of the resource group to which the dedicated block storage cluster belongs.	None.
ExpiredTime	String	The expiration time of the dedicated block storage cluster. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Unit: seconds.	None.
AvailableCapacity	String	The available capacity of the dedicated block storage cluster. Unit: GiB.	None.
UsedCapacity	String	The used (created) capacity of the dedicated block storage cluster. Unit: GiB.	None.
DeliveryCapacity	String	The capacity to be delivered for the dedicated block storage cluster. Unit: GiB.	None.
SupportedCategory	String	The supported cloud disk category.	None.
PerformanceLevel	String	The performance level (PL) of the cloud disk.	None.
CreateTime	String	The creation time of the dedicated block storage cluster.	None.
TotalCapacity	String	The total capacity of the dedicated block storage cluster. Unit: GiB.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DedicatedBlockStorageClusterId:
    Type: String
    Description:
      en: The ID of the dedicated block storage cluster.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::EBS::DedicatedBlockStorageClusters
    Properties:
      DedicatedBlockStorageClusterId:
        Ref: DedicatedBlockStorageClusterId
Outputs:
  DedicatedBlockStorageClusters:
    Description: The list of dedicated block storage clusters.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedBlockStorageClusters
  DedicatedBlockStorageClusterIds:
    Description: The list of dedicated block storage cluster IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedBlockStorageClusterIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DedicatedBlockStorageClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the dedicated block storage cluster."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DedicatedBlockStorageClusters",
      "Properties": {
        "DedicatedBlockStorageClusterId": {
          "Ref": "DedicatedBlockStorageClusterId"
        }
      }
    }
  },
  "Outputs": {
    "DedicatedBlockStorageClusters": {
      "Description": "The list of dedicated block storage clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedBlockStorageClusters"
        ]
      }
    },
    "DedicatedBlockStorageClusterIds": {
      "Description": "The list of dedicated block storage cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedBlockStorageClusterIds"
        ]
      }
    }
  }
}