DATASOURCE::VPC::CommonBandwidthPackage プロパティ - ROS

DATASOURCE::VPC::CommonBandwidthPackage は、リージョン内のインターネット共有帯域幅インスタンスに関する情報をクエリするために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
CommonBandwidthPackageName	String	いいえ	はい	インターネット共有帯域幅インスタンスの名前。	なし。
CommonBandwidthPackageId	String	いいえ	はい	インターネット共有帯域幅インスタンスの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースのリフレッシュポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。 Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

Status: インターネット共有帯域幅インスタンスのステータス。
Description: インターネット共有帯域幅インスタンスの説明。
ResourceGroupId: リソースグループの ID。
CommonBandwidthPackageName: インターネット共有帯域幅インスタンスの名前。
ServiceManaged: リソースがサービスアカウントによって作成されたかどうかを示します。
InstanceChargeType: インターネット共有帯域幅インスタンスの課金方法。
Isp: 回線タイプ。
HasReservationData: 保留中の注文に関する情報が返されるかどうかを示します。
DeletionProtection: 削除保護機能が有効になっているかどうかを示します。
BusinessStatus: インターネット共有帯域幅インスタンスのサービスステータス。
ReservationInternetChargeType: 構成変更後の課金方法。
InternetChargeType: インターネット共有帯域幅インスタンスの課金方法。
ReservationOrderType: 更新方法。
Bandwidth: インターネット共有帯域幅インスタンスの最大帯域幅。
ExpiredTime: インターネット共有帯域幅インスタンスの有効期限が切れる時刻。
CreationTime: インターネット共有帯域幅インスタンスが作成された時刻。
PublicIpAddresses: インターネット共有帯域幅インスタンスに関連付けられているパブリック IP アドレス。
Ratio: 最低帯域幅コミットメントの割合。
ReservationActiveTime: 更新が有効になる時刻。
ReservationBandwidth: 構成変更後の新しい最大帯域幅。
CommonBandwidthPackageId: インターネット共有帯域幅インスタンスの ID。

例

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": "インターネット共有帯域幅インスタンスのステータス。有効な値:\n* Available: インターネット共有帯域幅インスタンスは利用可能です。\n* Modifying: インターネット共有帯域幅インスタンスは変更中です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "Description": {
      "Description": "インターネット共有帯域幅インスタンスの説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CommonBandwidthPackageName": {
      "Description": "インターネット共有帯域幅インスタンスの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageName"
        ]
      }
    },
    "ServiceManaged": {
      "Description": "リソースがサービスアカウントによって作成されたかどうかを示します。有効な値:\n* 0: リソースはサービスアカウントによって作成されていません。\n* 1: リソースはサービスアカウントによって作成されています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceManaged"
        ]
      }
    },
    "InstanceChargeType": {
      "Description": "インターネット共有帯域幅インスタンスの課金方法。有効な値:\n* PostPaid: 従量課金\n* PrePaid: サブスクリプション",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceChargeType"
        ]
      }
    },
    "Isp": {
      "Description": "回線タイプ。有効な値:\nBGP (デフォルト): BGP (マルチ ISP) 回線。\nBGP_PRO: BGP (マルチ ISP) Pro 回線。\nシングル ISP 帯域幅の使用が許可されている場合の有効な値:\nChinaTelecom\nChinaUnicom\nChinaMobile\nChinaTelecom_L2\nChinaUnicom_L2\nChinaMobile_L2",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "HasReservationData": {
      "Description": "保留中の注文に関する情報が返されるかどうかを示します。有効な値:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasReservationData"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "削除保護が有効になっているかどうかを示します。有効な値:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "インターネット共有帯域幅インスタンスのサービスステータス。有効な値:\n* Normal: インターネット共有帯域幅インスタンスは正常に動作しています。\n* FinancialLocked: インターネット共有帯域幅インスタンスで支払い遅延が発生しています。\n* Unactivated: インターネット共有帯域幅インスタンスはアクティブ化されていません。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BusinessStatus"
        ]
      }
    },
    "ReservationInternetChargeType": {
      "Description": "構成が変更された後の課金方法。有効な値:\n* PayBy95: 拡張 95 パーセンタイルで課金されます。\n* PayByBandwidth: 帯域幅で課金されます。\n* PayByDominantTraffic: 主要トラフィックで課金されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationInternetChargeType"
        ]
      }
    },
    "InternetChargeType": {
      "Description": "インターネット共有帯域幅インスタンスの課金方法。有効な値:\n* PayBy95: 拡張 95 パーセンタイルで課金されます。\n* PayByBandwidth: 帯域幅で課金されます。\n* PayByDominantTraffic: 主要トラフィックで課金されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetChargeType"
        ]
      }
    },
    "ReservationOrderType": {
      "Description": "更新方法。有効な値:\n* RENEWCHANGE: スペック変更を伴う更新\n* TEMP_UPGRADE: 一時的なスペックアップを伴う更新\n* UPGRADE: スペックアップを伴う更新",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationOrderType"
        ]
      }
    },
    "Bandwidth": {
      "Description": "インターネット共有帯域幅インスタンスの最大帯域幅。単位: Mbit/s。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "インターネット共有帯域幅インスタンスの有効期限が切れた時刻。時刻は YYYY-MM-DDThh:mm:ssZ 形式で表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "CreationTime": {
      "Description": "インターネット共有帯域幅インスタンスが作成された時刻。時刻は YYYY-MM-DDThh:mm:ssZ 形式で表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreationTime"
        ]
      }
    },
    "PublicIpAddresses": {
      "Description": "インターネット共有帯域幅インスタンスに関連付けられている Elastic IP アドレス (EIP)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddresses"
        ]
      }
    },
    "Ratio": {
      "Description": "最低帯域幅コミットメントの割合。 20 のみ返されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ratio"
        ]
      }
    },
    "ReservationActiveTime": {
      "Description": "更新が有効になった時刻。時刻は YYYY-MM-DDThh:mm:ssZ 形式で表示されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationActiveTime"
        ]
      }
    },
    "ReservationBandwidth": {
      "Description": "構成変更後の新しい最大帯域幅。単位: Mbit/s。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationBandwidth"
        ]
      }
    },
    "CommonBandwidthPackageId": {
      "Description": "インターネット共有帯域幅の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageId"
        ]
      }
    }
  }
}