DATASOURCE::EBS::DedicatedBlockStorageCluster - Resource Orchestration Service

DATASOURCE::EBS::DedicatedBlockStorageCluster is used to query the information about a dedicated block storage cluster.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

DedicatedBlockStorageClusterId

String

Yes

The ID of the dedicated block storage 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

Category: the category of cloud disks that can be created in the dedicated block storage cluster.
Description: the description of the dedicated block storage cluster.
ZoneId: the zone ID of the dedicated block storage cluster.
ResourceGroupId: the ID of the resource group to which the dedicated block storage cluster belongs.
DedicatedBlockStorageClusterId: the ID of the dedicated block storage cluster.
AvailableCapacity: the available capacity of the dedicated block storage cluster.
PerformanceLevel: the performance level (PL) of the cloud disk.
CreateTime: the creation time of the dedicated block storage cluster.
UsedCapacity: the used (created) capacity of the dedicated block storage cluster. Unit: GiB.
SupportedCategory: the supported cloud disk category.
Type: the type of the dedicated block storage cluster.
ExpiredTime: 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.
DedicatedBlockStorageClusterName: the name of the dedicated block storage cluster.
DeliveryCapacity: the capacity to be delivered for the dedicated block storage cluster. Unit: GiB.
TotalCapacity: the total storage capacity of the dedicated block storage cluster. Unit: GiB.
Tags: the tags that are added to the dedicated block storage cluster.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DedicatedBlockStorageClusterId:
    Type: String
    Description:
      en: The ID of the dedicated block storage cluster.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::EBS::DedicatedBlockStorageCluster
    Properties:
      DedicatedBlockStorageClusterId:
        Ref: DedicatedBlockStorageClusterId
Outputs:
  Category:
    Description: The category of disks that can be created in the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Category
  Description:
    Description: The description of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ZoneId:
    Description: The zone ID of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DedicatedBlockStorageClusterId:
    Description: The ID of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedBlockStorageClusterId
  AvailableCapacity:
    Description: 'The available capacity of the dedicated block storage cluster. Unit: GiB.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AvailableCapacity
  PerformanceLevel:
    Description: 'The performance level of disks. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PerformanceLevel
  CreateTime:
    Description: 'The time when the dedicated block storage cluster was created. The value is a UNIX timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  UsedCapacity:
    Description: The used (created disk) capacity of the current cluster, in GB.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UsedCapacity
  SupportedCategory:
    Description: This parameter is not supported.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SupportedCategory
  Type:
    Description: The dedicated block storage cluster performance type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Type
  ExpiredTime:
    Description: The expiration time of the dedicated block storage cluster, in the Unix timestamp format, in seconds.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  DedicatedBlockStorageClusterName:
    Description: The name of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DedicatedBlockStorageClusterName
  DeliveryCapacity:
    Description: 'The capacity to be delivered for the dedicated block storage cluster. Unit: GiB.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeliveryCapacity
  TotalCapacity:
    Description: 'The total capacity of the dedicated block storage cluster. Unit: GiB.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TotalCapacity
  Tags:
    Description: The tags of the dedicated block storage cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DedicatedBlockStorageClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the dedicated block storage cluster."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EBS::DedicatedBlockStorageCluster",
      "Properties": {
        "DedicatedBlockStorageClusterId": {
          "Ref": "DedicatedBlockStorageClusterId"
        }
      }
    }
  },
  "Outputs": {
    "Category": {
      "Description": "The category of disks that can be created in the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Category"
        ]
      }
    },
    "Description": {
      "Description": "The description of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ZoneId": {
      "Description": "The zone ID of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DedicatedBlockStorageClusterId": {
      "Description": "The ID of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedBlockStorageClusterId"
        ]
      }
    },
    "AvailableCapacity": {
      "Description": "The available capacity of the dedicated block storage cluster. Unit: GiB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AvailableCapacity"
        ]
      }
    },
    "PerformanceLevel": {
      "Description": "The performance level of disks. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PerformanceLevel"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the dedicated block storage cluster was created. The value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "UsedCapacity": {
      "Description": "The used (created disk) capacity of the current cluster, in GB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UsedCapacity"
        ]
      }
    },
    "SupportedCategory": {
      "Description": "This parameter is not supported.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportedCategory"
        ]
      }
    },
    "Type": {
      "Description": "The dedicated block storage cluster performance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Type"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The expiration time of the dedicated block storage cluster, in the Unix timestamp format, in seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "DedicatedBlockStorageClusterName": {
      "Description": "The name of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DedicatedBlockStorageClusterName"
        ]
      }
    },
    "DeliveryCapacity": {
      "Description": "The capacity to be delivered for the dedicated block storage cluster. Unit: GiB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeliveryCapacity"
        ]
      }
    },
    "TotalCapacity": {
      "Description": "The total capacity of the dedicated block storage cluster. Unit: GiB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TotalCapacity"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the dedicated block storage cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}