使用可能な IP アドレスプールをクエリするための DATASOURCE::VPC::PublicIpAddressPools の使用方法 - Resource Orchestration Service

DATASOURCE::VPC::PublicIpAddressPools は、使用可能な IP アドレスプールをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::PublicIpAddressPools",
  "Properties": {
    "ResourceGroupId": String,
    "PublicIpAddressPoolName": String,
    "Isp": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceGroupId	String	いいえ	はい	IP アドレスプールが属するリソースグループの ID。	なし。
PublicIpAddressPoolName	String	いいえ	はい	IP アドレスプールの名前。	このプロパティはオプションです。名前は 1 ～ 128 文字で、文字、数字、ピリオド(.)、アンダースコア(_) 、ハイフン(-) を含めることができます。名前は文字で始める必要がありますが、`http://` または `https://` で始めることはできません。
Isp	String	いいえ	はい	回線タイプ。	有効な値: BGP: BGP (マルチ ISP) BGP_PRO: BGP (マルチ ISP) Pro BGP (マルチ ISP) と BGP (マルチ ISP) Pro の詳細については、「エラスティック IP アドレスとは」をご参照ください。シングル ISP 帯域幅の使用が許可されている場合は、次のいずれかの値が返される場合があります。 ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 サービスが中国東部 1 ファイナンスにデプロイされている場合は、BGP_FinanceCloud が返されます。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースを更新しません。 Always: スタックの更新時にデータソースリソースを更新します。

戻り値

Fn::GetAtt

PublicIpAddressPoolIds: IP アドレスプールの ID。
PublicIpAddressPools: IP アドレスプールの詳細。

プロパティ	タイプ	説明	制約
PublicIpAddressPoolIds	List	IP アドレスプールの ID。	なし。
PublicIpAddressPoolIds	List	IP アドレスプールの詳細。	なし。
Status	String	IP アドレスプールのステータス。	なし。
Isp	String	回線タイプ。	なし。
Description	String	IP アドレスプールの説明。	なし。
IpAddressRemaining	Boolean	IP アドレスプールにアイドル状態の IP アドレスがあるかどうかを示します。	有効な値: true false
Tags	List	タグ。	なし。
TotalIpNum	Integer	パブリック IP アドレスプール内の IP アドレスの総数。	なし。
PublicIpAddressPoolId	String	IP アドレスプールの ID。	なし。
ResourceGroupId	String	IP アドレスプールが属するリソースグループの ID。	なし。
CreateTime	String	IP アドレスプールが作成された時刻。	なし。
UsedIpNum	String	パブリック IP アドレスプール内で使用されている IP アドレスの数。	なし。
PublicIpAddressPoolName	String	IP アドレスプールの名前。	なし。
RegionId	String	IP アドレスプールが存在するリージョンの ID。	なし。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Isp:
    AllowedValues:
    - BGP
    - BGP_PRO
    - ChinaTelecom
    - ChinaUnicom
    - ChinaMobile
    - ChinaTelecom_L2
    - ChinaUnicom_L2
    - ChinaMobile_L2
    Description: "回線タイプ。有効な値：\nBGP (デフォルト): BGP (マルチ ISP) 回線\nBGP_PRO: BGP (マルチ ISP) Pro 回線\nBGP (マルチ ISP) と BGP (マルチ ISP) Pro の詳細については、「EIP 回線タイプ」をご参照ください。\nシングル ISP 帯域幅の使用が許可されている場合は、次のいずれかの値も選択できます。\nChinaTelecom: China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2: China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile L2\nサービスが中国東部 1 ファイナンスにデプロイされている場合は、\nこのパラメーターは必須であり、値を BGP_FinanceCloud に設定する必要があります。"
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      Isp:
        Ref: Isp
    Type: DATASOURCE::VPC::PublicIpAddressPools
Outputs:
  PublicIpAddressPoolIds:
    Description: パブリック IP アドレスプール ID のリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPoolIds
  PublicIpAddressPools:
    Description: パブリック IP アドレスプールのリスト。
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPools

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Isp": {
      "Type": "String",
      "Description": "回線タイプ。有効な値：\nBGP (デフォルト): BGP (マルチ ISP) 回線\nBGP_PRO: BGP (マルチ ISP) Pro 回線\nBGP (マルチ ISP) と BGP (マルチ ISP) Pro の詳細については、「EIP 回線タイプ」をご参照ください。\nシングル ISP 帯域幅の使用が許可されている場合は、次のいずれかの値も選択できます。\nChinaTelecom: China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2: China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile L2\nサービスが中国東部 1 ファイナンスにデプロイされている場合は、\nこのパラメーターは必須であり、値を BGP_FinanceCloud に設定する必要があります。",
      "AllowedValues": [
        "BGP",
        "BGP_PRO",
        "ChinaTelecom",
        "ChinaUnicom",
        "ChinaMobile",
        "ChinaTelecom_L2",
        "ChinaUnicom_L2",
        "ChinaMobile_L2"
      ]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PublicIpAddressPools",
      "Properties": {
        "Isp": {
          "Ref": "Isp"
        }
      }
    }
  },
  "Outputs": {
    "PublicIpAddressPoolIds": {
      "Description": "パブリック IP アドレスプール ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolIds"
        ]
      }
    },
    "PublicIpAddressPools": {
      "Description": "パブリック IP アドレスプールのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPools"
        ]
      }
    }
  }
}