VPC パブリック IP アドレスプールの ROS DATASOURCER ファレンス - Resource Orchestration Service

DATASOURCE::VPC::PublicIpAddressPool は、使用可能な IP アドレスプールの基本情報を照会するために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::PublicIpAddressPool",
  "Properties": {
    "PublicIpAddressPoolId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

PublicIpAddressPoolId

String

はい

IP アドレスプールの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

UsedIpNum: IP アドレスプールで使用可能な IP アドレスの総数。
Description: IP アドレスプールの説明。
ResourceGroupId: リソースグループの ID。
TotalIpNum: IP アドレスプールで使用されている IP アドレスの数。
PublicIpAddressPoolName: IP アドレスプールの名前。
Isp: 回線タイプ。
CreateTime: IP アドレスプールが作成された時刻。
IpAddressRemaining: アイドル状態の IP アドレスが存在するかどうかを示します。
PublicIpAddressPoolId: 弾性 IP アドレス (EIP) が属する IP アドレスプールの ID。
Tags: EIP のタグ。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PublicIpAddressPoolId:
    Type: String
    Description:
      en: The first ID of the resource.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::PublicIpAddressPool
    Properties:
      PublicIpAddressPoolId:
        Ref: PublicIpAddressPoolId
Outputs:
  UsedIpNum:
    Description: Used ip number of PublicIpAddressPool.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UsedIpNum
  Description:
    Description: Description.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The ID of the resource group to which the VPC belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  TotalIpNum:
    Description: Total ip number of PublicIpAddressPool.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TotalIpNum
  PublicIpAddressPoolName:
    Description: The name of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicIpAddressPoolName
  Isp:
    Description: Service providers.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Isp
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  IpAddressRemaining:
    Description: Whether there is a free IP address.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IpAddressRemaining
  PublicIpAddressPoolId:
    Description: The first ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicIpAddressPoolId
  Tags:
    Description: The tags of PrefixList.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PublicIpAddressPoolId": {
      "Type": "String",
      "Description": {
        "en": "The first ID of the resource."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PublicIpAddressPool",
      "Properties": {
        "PublicIpAddressPoolId": {
          "Ref": "PublicIpAddressPoolId"
        }
      }
    }
  },
  "Outputs": {
    "UsedIpNum": {
      "Description": "Used ip number of PublicIpAddressPool.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UsedIpNum"
        ]
      }
    },
    "Description": {
      "Description": "Description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group to which the VPC belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "TotalIpNum": {
      "Description": "Total ip number of PublicIpAddressPool.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TotalIpNum"
        ]
      }
    },
    "PublicIpAddressPoolName": {
      "Description": "The name of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolName"
        ]
      }
    },
    "Isp": {
      "Description": "Service providers.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "IpAddressRemaining": {
      "Description": "Whether there is a free IP address.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpAddressRemaining"
        ]
      }
    },
    "PublicIpAddressPoolId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolId"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of PrefixList.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}