DATASOURCE::VPC::CommonBandwidthPackage - Resource Orchestration Service

DATASOURCE::VPC::CommonBandwidthPackage is used to query the information about an Internet Shared Bandwidth instance in a region.

Syntax

{
  "Type": "DATASOURCE::VPC::CommonBandwidthPackage",
  "Properties": {
    "CommonBandwidthPackageName": String,
    "CommonBandwidthPackageId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
CommonBandwidthPackageName	String	No	Yes	The name of the Internet Shared Bandwidth instance.	None.
CommonBandwidthPackageId	String	No	Yes	The ID of the Internet Shared Bandwidth instance.	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

Status: the status of the Internet Shared Bandwidth instance.
Description: the description of the Internet Shared Bandwidth instance.
ResourceGroupId: the ID of the resource group.
CommonBandwidthPackageName: the name of the Internet Shared Bandwidth instance.
ServiceManaged: indicates whether the resource is created by the service account.
InstanceChargeType: the billing method of the Internet Shared Bandwidth instance.
Isp: the line type.
HasReservationData: indicates whether the information about pending orders is returned.
DeletionProtection: indicates whether the deletion protection feature is enabled.
BusinessStatus: the service status of the Internet Shared Bandwidth instance.
ReservationInternetChargeType: the billing method after the configurations are changed.
InternetChargeType: the billing method of the Internet Shared Bandwidth instance.
ReservationOrderType: the renewal method.
Bandwidth: the maximum bandwidth of the Internet Shared Bandwidth instance.
ExpiredTime: the time when the Internet Shared Bandwidth instance expires.
CreationTime: the time when the Internet Shared Bandwidth instance was created.
PublicIpAddresses: the public IP addresses that are associated with the Internet Shared Bandwidth instance.
Ratio: the percentage of the minimum bandwidth commitment.
ReservationActiveTime: the time when the renewal takes effect.
ReservationBandwidth: the new maximum bandwidth after the configurations are changed.
CommonBandwidthPackageId: the ID of the Internet Shared Bandwidth instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CommonBandwidthPackageName:
    Type: String
    Description:
      en: The name of the Internet Shared Bandwidth instance.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::CommonBandwidthPackage
    Properties:
      CommonBandwidthPackageName:
        Ref: CommonBandwidthPackageName
Outputs:
  Status:
    Description: |-
      The status of the Internet Shared Bandwidth instance. Valid values:
      * Available: The Internet Shared Bandwidth instance is available.
      * Modifying: The Internet Shared Bandwidth instance is being modified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Status
  Description:
    Description: The description of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CommonBandwidthPackageName:
    Description: The name of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageName
  ServiceManaged:
    Description: |-
      Indicates whether the resource is created by the service account. Valid values:
      * 0: The resource is not created by the service account.
      * 1: The resource is created by the service account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceManaged
  InstanceChargeType:
    Description: |-
      The billing method of the Internet Shared Bandwidth instance. Valid value:
      * PostPaid: pay-as-you-go
      * PrePaid: subscription
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceChargeType
  Isp:
    Description: |-
      The line type. Valid values:
      BGP (default): BGP (Multi-ISP) lines.
      BGP_PRO: BGP (Multi-ISP) Pro lines.
      Valid values if you are allowed to use single-ISP bandwidth:
      ChinaTelecom
      ChinaUnicom
      ChinaMobile
      ChinaTelecom_L2
      ChinaUnicom_L2
      ChinaMobile_L2
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Isp
  HasReservationData:
    Description: |-
      Indicates whether the information about pending orders is returned. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HasReservationData
  DeletionProtection:
    Description: |-
      Indicates whether deletion protection is enabled. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeletionProtection
  BusinessStatus:
    Description: |-
      The service status of the Internet Shared Bandwidth instance. Valid values:
      * Normal: The Internet Shared Bandwidth instance runs as expected.
      * FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance
      * Unactivated: The Internet Shared Bandwidth instance is not activated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BusinessStatus
  ReservationInternetChargeType:
    Description: |-
      The billing method after the configurations are changed. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationInternetChargeType
  InternetChargeType:
    Description: |-
      The billing method of the Internet Shared Bandwidth instance. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InternetChargeType
  ReservationOrderType:
    Description: |-
      The renewal method. Valid values:
      * RENEWCHANGE: renewal with a specification change
      * TEMP_UPGRADE: renewal with a temporary upgrade
      * UPGRADE: renewal with an upgrade
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationOrderType
  Bandwidth:
    Description: 'The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Bandwidth
  ExpiredTime:
    Description: The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  CreationTime:
    Description: The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreationTime
  PublicIpAddresses:
    Description: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicIpAddresses
  Ratio:
    Description: The percentage of the minimum bandwidth commitment. Only 20 is returned.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Ratio
  ReservationActiveTime:
    Description: The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationActiveTime
  ReservationBandwidth:
    Description: 'The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationBandwidth
  CommonBandwidthPackageId:
    Description: The ID of the Internet shared bandwidth.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CommonBandwidthPackageName": {
      "Type": "String",
      "Description": {
        "en": "The name of the Internet Shared Bandwidth instance."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CommonBandwidthPackage",
      "Properties": {
        "CommonBandwidthPackageName": {
          "Ref": "CommonBandwidthPackageName"
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "The status of the Internet Shared Bandwidth instance. Valid values:\n* Available: The Internet Shared Bandwidth instance is available.\n* Modifying: The Internet Shared Bandwidth instance is being modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "Description": {
      "Description": "The description of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CommonBandwidthPackageName": {
      "Description": "The name of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageName"
        ]
      }
    },
    "ServiceManaged": {
      "Description": "Indicates whether the resource is created by the service account. Valid values:\n* 0: The resource is not created by the service account.\n* 1: The resource is created by the service account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceManaged"
        ]
      }
    },
    "InstanceChargeType": {
      "Description": "The billing method of the Internet Shared Bandwidth instance. Valid value:\n* PostPaid: pay-as-you-go\n* PrePaid: subscription",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceChargeType"
        ]
      }
    },
    "Isp": {
      "Description": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines.\nBGP_PRO: BGP (Multi-ISP) Pro lines.\nValid values if you are allowed to use single-ISP bandwidth:\nChinaTelecom\nChinaUnicom\nChinaMobile\nChinaTelecom_L2\nChinaUnicom_L2\nChinaMobile_L2",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "HasReservationData": {
      "Description": "Indicates whether the information about pending orders is returned. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasReservationData"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "Indicates whether deletion protection is enabled. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "The service status of the Internet Shared Bandwidth instance. Valid values:\n* Normal: The Internet Shared Bandwidth instance runs as expected.\n* FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance\n* Unactivated: The Internet Shared Bandwidth instance is not activated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BusinessStatus"
        ]
      }
    },
    "ReservationInternetChargeType": {
      "Description": "The billing method after the configurations are changed. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationInternetChargeType"
        ]
      }
    },
    "InternetChargeType": {
      "Description": "The billing method of the Internet Shared Bandwidth instance. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetChargeType"
        ]
      }
    },
    "ReservationOrderType": {
      "Description": "The renewal method. Valid values:\n* RENEWCHANGE: renewal with a specification change\n* TEMP_UPGRADE: renewal with a temporary upgrade\n* UPGRADE: renewal with an upgrade",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationOrderType"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "CreationTime": {
      "Description": "The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreationTime"
        ]
      }
    },
    "PublicIpAddresses": {
      "Description": "The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddresses"
        ]
      }
    },
    "Ratio": {
      "Description": "The percentage of the minimum bandwidth commitment. Only 20 is returned.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ratio"
        ]
      }
    },
    "ReservationActiveTime": {
      "Description": "The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationActiveTime"
        ]
      }
    },
    "ReservationBandwidth": {
      "Description": "The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationBandwidth"
        ]
      }
    },
    "CommonBandwidthPackageId": {
      "Description": "The ID of the Internet shared bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageId"
        ]
      }
    }
  }
}