DATASOURCE::NLB::LoadBalancers を使用して NLB インスタンスをクエリ - ROS

DATASOURCE::NLB::LoadBalancers は、作成されたネットワークロードバランサー（NLB）インスタンスに関する基本情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::NLB::LoadBalancers",
  "Properties": {
    "LoadBalancerNames": List,
    "AddressIpVersion": String,
    "LoadBalancerBussinessStatus": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VpcIds": List,
    "LoadBalancerIds": List,
    "AddressType": String,
    "LoadBalancerStatus": String,
    "Tags": List,
    "Ipv6AddressType": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
LoadBalancerNames	List	いいえ	はい	NLB インスタンスの名前。	リクエストで最大 20 インスタンスをクエリできます。
AddressIpVersion	String	いいえ	はい	プロトコルバージョン。	有効な値： ipv4 DualStack
LoadBalancerBussinessStatus	String	いいえ	はい	NLB インスタンスのビジネスステータス。	有効な値： Abnormal Normal
ZoneId	String	いいえ	はい	ゾーン ID。	なし。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
VpcIds	List	いいえ	はい	NLB インスタンスが存在する仮想プライベートクラウド（VPC）の ID。	リクエストで最大 10 VPC をクエリできます。
LoadBalancerIds	List	いいえ	はい	NLB インスタンスの ID。	リクエストで最大 20 インスタンスをクエリできます。
AddressType	String	いいえ	はい	NLB インスタンスで使用される IPv4 アドレスのタイプ。	有効な値： Internet：インスタンスはパブリック IP アドレスを使用します。インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、インスタンスにはインターネット経由でアクセスできます。 Intranet：インスタンスはプライベート IP アドレスを使用します。インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、インスタンスにはインスタンスの VPC 経由でのみアクセスできます。
LoadBalancerStatus	String	いいえ	はい	NLB インスタンスのステータス。	有効な値： Inactive：NLB インスタンスは停止しています。Inactive 状態の NLB インスタンスのリスナーはトラフィックを転送しません。 Active：NLB インスタンスは実行中です。 Provisioning：NLB インスタンスは作成中です。 Configuring：NLB インスタンスの構成が変更されています。 Deleting：NLB インスタンスは削除中です。 Deleted：NLB インスタンスは削除されました。
Tags	List	いいえ	はい	NLB インスタンスのタグ。	リクエストで最大 20 タグを追加できます。
Ipv6AddressType	String	いいえ	はい	NLB インスタンスで使用される IPv6 アドレスのタイプ。	有効な値： Internet：インスタンスはパブリック IP アドレスを使用します。インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、インスタンスにはインターネット経由でアクセスできます。 Intranet：インスタンスはプライベート IP アドレスを使用します。インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、インスタンスにはインスタンスの VPC 経由でのみアクセスできます。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックの更新時にデータソースリソースを更新しません。 Always：スタックの更新時にデータソースリソースを更新します。

タグの構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

LoadBalancerIds：NLB インスタンスの ID。
LoadBalancers：NLB インスタンスの詳細。

プロパティ	タイプ	説明	制約
LoadBalancerIds	List	NLB インスタンスの ID。	なし。
LoadBalancers	List	NLB インスタンスの詳細。	なし。
LoadBalancerId	String	NLB インスタンスの ID。	なし。
LoadBalancerName	String	NLB インスタンスの名前。	なし。
LoadBalancerType	String	サーバーロードバランサー（SLB）インスタンスのタイプ。	Network のみ返されます。これは、インスタンスが NLB インスタンスであることを示します。
AddressType	String	NLB インスタンスで使用される IPv4 アドレスのタイプ。	有効な値： Internet：インスタンスはパブリック IP アドレスを使用します。インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、インスタンスにはインターネット経由でアクセスできます。 Intranet：インスタンスはプライベート IP アドレスを使用します。インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、インスタンスにはインスタンスの VPC 経由でのみアクセスできます。
AddressIpVersion	String	プロトコルバージョン。	有効な値： ipv4 DualStack
Ipv6AddressType	String	NLB インスタンスで使用される IPv6 アドレスのタイプ。	有効な値： Internet：インスタンスはパブリック IP アドレスを使用します。インスタンスのドメイン名はパブリック IP アドレスに解決されます。そのため、インスタンスにはインターネット経由でアクセスできます。 Intranet：インスタンスはプライベート IP アドレスを使用します。インスタンスのドメイン名はプライベート IP アドレスに解決されます。そのため、インスタンスにはインスタンスの VPC 経由でのみアクセスできます。
LoadBalancerStatus	String	NLB インスタンスのステータス。	有効な値： Inactive：NLB インスタンスは停止しています。Inactive 状態の NLB インスタンスのリスナーはトラフィックを転送しません。 Active：NLB インスタンスは実行中です。 Provisioning：NLB インスタンスは作成中です。 Configuring：NLB インスタンスの構成が変更されています。 Deleting：NLB インスタンスは削除中です。 Deleted：NLB インスタンスは削除されました。
LoadBalancerBusinessStatus	String	NLB インスタンスのビジネスステータス。	有効な値： Abnormal Normal
VpcId	String	NLB インスタンスが存在する VPC の ID。	なし。
CreateTime	String	NLB インスタンスが作成された時刻。	時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は UTC で表示されます。
ResourceGroupId	String	リソースグループの ID。	なし。
DNSName	String	ドメイン名。	なし。
BandwidthPackageId	String	インターネット向けインスタンスに関連付けられているインターネット共有帯域幅インスタンスの ID。	なし。
SecurityGroupIds	List	NLB インスタンスが追加されるセキュリティグループ。	[ "sg-bp67acfmxazb4p****" ]
CrossZoneEnabled	Boolean	NLB インスタンスでクロスゾーンロードバランシングが有効になっているかどうかを示します。	有効な値： true false
Tags	List	タグ。	例： `[ { "Key" : "KeyTest", "Value" : "ValueTest" } ]`
PayType	String	NLB インスタンスの課金方法。	PostPay のみ返されます。これは、インスタンスが従量課金制を使用していることを示します。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::NLB::LoadBalancers
    Properties:
      AddressIpVersion: ipv4
Outputs:
  LoadBalancerIds:
    Description: ロードバランサー ID のリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancerIds
  LoadBalancers:
    Description: ロードバランサーのリスト。
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancers

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NLB::LoadBalancers",
      "Properties": {
        "AddressIpVersion": "ipv4"
      }
    }
  },
  "Outputs": {
    "LoadBalancerIds": {
      "Description": "ロードバランサー ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancerIds"
        ]
      }
    },
    "LoadBalancers": {
      "Description": "ロードバランサーのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancers"
        ]
      }
    }
  }
}