DATASOURCE::CEN::CenBandwidthPackages を使用した Resource Orchestration Service (ROS) の CEN 帯域幅プランのクエリ - ROS

DATASOURCE::CEN::CenBandwidthPackages は、ログオンアカウント内のクラウドエンタープライズネットワーク (CEN) 帯域幅プランに関する情報を照会するために使用されます。

構文

{
  "Type": "DATASOURCE::CEN::CenBandwidthPackages",
  "Properties": {
    "IsOrKey": Boolean,
    "Filter": List,
    "IncludeReservationData": Boolean,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
IsOrKey	Boolean	いいえ	はい	フィルターに OR 論理演算子を適用するかどうかを指定します。	有効な値: true: フィルターに OR 論理演算子が適用されます。いずれかのフィルターを満たす帯域幅プランが返されます。 false (デフォルト): フィルターに AND 論理演算子が適用されます。すべてのフィルターを満たす帯域幅プランが返されます。
Filter	List	いいえ	はい	フィルター。	詳細については、「フィルターのプロパティ」をご参照ください。
IncludeReservationData	Boolean	いいえ	はい	更新データを含めるかどうかを指定します。	有効な値: true false
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

フィルターの構文

"Filter": [
  {
    "Value": List,
    "Key": String
  }
]

フィルターのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Value

List

いいえ

フィルターの値。フィルターキーに基づいてフィルター値を指定できます。

1 つのフィルターキーに複数のフィルター値を指定できます。フィルター値間の論理演算子は OR です。いずれかのフィルター値を満たす帯域幅プランが返されます。

Key

String

はい

いいえ

フィルターのキー。

有効な値:

CenId: CEN インスタンスの ID
Status: 帯域幅プランのステータス
CenBandwidthPackageId: 帯域幅プランの ID
Name: 帯域幅プランの名前

戻り値 (Fn::GetAtt)

CenBandwidthPackages: 帯域幅プランの詳細。
CenBandwidthPackageIds: 帯域幅プランの ID。

プロパティ	タイプ	説明	制約
CenBandwidthPackageIds	List	帯域幅プランの ID。	なし。
CenBandwidthPackages	List	帯域幅プランの詳細。	なし。
ReservationActiveTime	String	一時的なアップグレードの有効期限。	なし。
CenBandwidthPackageId	String	帯域幅プランの ID。	なし。
Status	String	帯域幅プランが CEN インスタンスに関連付けられているかどうかを示します。	有効な値: Idle: 帯域幅プランは CEN インスタンスに関連付けられていません。 InUse: 帯域幅プランは CEN インスタンスに関連付けられています。
CreationTime	String	帯域幅プランが作成された時刻。	時刻は YYYY-MM-DDThh:mmZ 形式の ISO 8601 標準に準拠しています。
ReservationOrderType	String	更新中の構成変更のタイプ。	有効な値: TEMP_UPGRADE: 一時的なアップグレード UPGRADE: アップグレード
BandwidthPackageChargeType	String	帯域幅プランの課金方法。	なし。
ReservationInternetChargeType	String	構成変更後の課金方法。	なし。
GeographicRegionAId	String	照会されるエリアの ID。	有効な値: china: 中国本土 asia-pacific: アジア太平洋 europe: ヨーロッパ australia: オーストラリア north-america: 北米
Bandwidth	Number	帯域幅プランの最大帯域幅。	なし。
Description	String	帯域幅プランの説明。	なし。
ExpiredTime	String	帯域幅プランの有効期限。	時刻は YYYY-MM-DDThh:mmZ 形式の ISO 8601 標準に準拠しています。
ReservationBandwidth	String	一時的なアップグレードが終了したときに帯域幅プランが復元される帯域幅。	なし。
GeographicSpanId	String	接続されているエリアの ID。	なし。
GeographicRegionBId	String	帯域幅プランのリージョン間接続で使用される別のエリアの ID。	有効な値: china: 中国本土 asia-pacific: アジア太平洋 europe: ヨーロッパ australia: オーストラリア north-america: 北米
IsCrossBorder	Boolean	帯域幅プランがクロスボーダー帯域幅プランかどうかを示します。	有効な値: true false
BusinessStatus	String	帯域幅プランの状態。	有効な値: Normal: 帯域幅プランは正常に動作しています。 FinancialLocked: 帯域幅プランは、支払いの延滞によりロックされています。 SecurityLocked: 帯域幅プランは、セキュリティ上の理由によりロックされています。
Name	String	帯域幅プランの名前。	なし。
HasReservationData	String	更新データが含まれているかどうかを示します。	有効な値: true false 説明 IncludeReservationData プロパティが true に設定されていて、特定の注文が有効になっていない場合、システムはこのプロパティに true を返します。
CenIds	List	帯域幅プランに関連付けられている CEN インスタンスの ID。	例: `[ "cen-xxjsjfkffkfkfjkf****" ]`
OrginInterRegionBandwidthLimits	Map	リージョン間接続の詳細。	例: `{ "BandwidthLimit" : "1", "OppositeRegionId" : "us-west-1", "GeographicSpanId" : "north-america_china", "LocalRegionId" : "cn-hangzhou" }`

例

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IncludeReservationData": {
      "Type": "Boolean",
      "Description": "更新データを含めるかどうかを指定します。", // 翻訳済
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CEN::CenBandwidthPackages",
      "Properties": {
        "IncludeReservationData": {
          "Ref": "IncludeReservationData"
        }
      }
    }
  },
  "Outputs": {
    "CenBandwidthPackages": {
      "Description": "CenBandwidthPackages に関する情報。", // 翻訳済
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CenBandwidthPackages"
        ]
      }
    },
    "CenBandwidthPackageIds": {
      "Description": "CEN 帯域幅 ID のリスト。", // 翻訳済
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CenBandwidthPackageIds"
        ]
      }
    }
  }
}

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IncludeReservationData:
    Type: Boolean
    Description: 更新データを含めるかどうかを指定します。 # 翻訳済
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::CEN::CenBandwidthPackages
    Properties:
      IncludeReservationData:
        Ref: IncludeReservationData
Outputs:
  CenBandwidthPackages:
    Description: CenBandwidthPackages に関する情報。 # 翻訳済
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CenBandwidthPackages
  CenBandwidthPackageIds:
    Description: CEN 帯域幅 ID のリスト。 # 翻訳済
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CenBandwidthPackageIds

構文