DATASOURCE::VPC::NatGateways を使用して NAT ゲートウェイを照会する - Resource Orchestration Service

DATASOURCE::VPC::NatGateways は、NAT ゲートウェイを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::VPC::NatGateways",
  "Properties": {
    "Status": String,
    "VpcId": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "InstanceChargeType": String,
    "NetworkType": String,
    "NatType": String,
    "NatGatewayId": String,
    "Name": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Status	String	いいえ	はい	NAT ゲートウェイの状態。	有効な値: Creating: NAT ゲートウェイは作成中です。NAT ゲートウェイを作成する操作は非同期です。NAT ゲートウェイは、作成されるまで Creating 状態のままです。 Available: NAT ゲートウェイは利用可能です。NAT ゲートウェイは、作成された後に Available 状態になります。 Modifying: NAT ゲートウェイは変更中です。NAT ゲートウェイを変更する操作は非同期です。NAT ゲートウェイは、変更されるまで Modifying 状態のままです。 Deleting: NAT ゲートウェイは削除中です。NAT ゲートウェイを削除する操作は非同期です。NAT ゲートウェイは、削除されるまで Deleting 状態のままです。 Converting: NAT ゲートウェイは変換中です。標準 NAT ゲートウェイを拡張 NAT ゲートウェイに変換する操作は非同期です。NAT ゲートウェイは、変換されるまで Converting 状態のままです。
VpcId	String	いいえ	はい	NAT ゲートウェイがデプロイされている仮想プライベートクラウド (VPC) の ID。	なし。
ZoneId	String	いいえ	はい	NAT ゲートウェイが属するゾーンの ID。	なし。
ResourceGroupId	String	いいえ	はい	NAT ゲートウェイが属するリソースグループの ID。	なし。
InstanceChargeType	String	いいえ	はい	NAT ゲートウェイの課金方式。	有効な値: PostPaid: 従量課金プリペイド: サブスクリプション説明サブスクリプション NAT ゲートウェイを購入することはできません。
NetworkType	String	いいえ	はい	NAT ゲートウェイのネットワークタイプ。	有効な値: internet intranet
NatType	String	いいえ	はい	NAT ゲートウェイのタイプ。	値を Enhanced に設定します。これは拡張 NAT ゲートウェイを指定します。
NatGatewayId	String	いいえ	はい	NAT ゲートウェイの ID。	なし。
Name	String	いいえ	はい	NAT ゲートウェイの名前。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

NatGatewayIds: NAT ゲートウェイの ID。
NatGateways: NAT ゲートウェイの詳細。

プロパティ	タイプ	説明	制約
NatGatewayIds	List	NAT ゲートウェイの ID。	例: `["ngw-2ze9v06hwq9h3jxw**", "ngw-2zadhak06hwq9h3jxw**"]`。
NatGateways	List	NAT ゲートウェイの詳細。	なし。
Status	String	NAT ゲートウェイの状態。	有効な値: Creating: NAT ゲートウェイは作成中です。 NAT ゲートウェイを作成する操作は非同期です。 NAT ゲートウェイは、作成されるまで Creating 状態のままです。 Available: NAT ゲートウェイは利用可能です。 NAT ゲートウェイは、作成された後に Available 状態になります。 Modifying: NAT ゲートウェイは変更中です。 NAT ゲートウェイを変更する操作は非同期です。 NAT ゲートウェイは、変更されるまで Modifying 状態のままです。 Deleting: NAT ゲートウェイは削除中です。 NAT ゲートウェイを削除する操作は非同期です。 NAT ゲートウェイは、削除されるまで Deleting 状態のままです。 Converting: NAT ゲートウェイは変換中です。標準 NAT ゲートウェイを拡張 NAT ゲートウェイに変換する操作は非同期です。 NAT ゲートウェイは、変換されるまで Converting 状態のままです。
CreationTime	String	NAT ゲートウェイが作成された時刻。	例: `2021-06-08T12:20:20Z`。
VpcId	String	NAT ゲートウェイがデプロイされている VPC の ID。	例: `vpc-bp15zckdt37pq72z****`。
NatType	String	NAT ゲートウェイのタイプ。	このプロパティには Enhanced という値が返されます。この値は、拡張 NAT ゲートウェイを示します。
Spec	String	インターネット NAT ゲートウェイの仕様。	このプロパティは、InstanceChargeType が PrePaid に設定されている場合にのみ有効になります。有効な値: Small: 小型 NAT ゲートウェイ Middle: 中型 NAT ゲートウェイ Large: 大型 NAT ゲートウェイ
DeletionProtection	Boolean	削除保護が有効になっているかどうかを示します。	有効な値: true false
NetworkType	String	NAT ゲートウェイのネットワークタイプ。	有効な値: internet intranet
SecurityProtectionEnabled	Boolean	セキュリティ保護機能が有効になっているかどうかを示します。	有効な値: true false
InstanceChargeType	String	NAT ゲートウェイの課金方式。	有効な値: PostPaid: 従量課金プリペイド: サブスクリプション説明サブスクリプション NAT ゲートウェイを購入することはできません。
EcsMetricEnabled	Boolean	トラフィック監視機能が有効になっているかどうかを示します。	有効な値: true false
IcmpReplyEnabled	Boolean	インターネット制御メッセージプロトコル (ICMP) 非取得機能が有効になっているかどうかを示します。	有効な値: true false
Description	String	NAT ゲートウェイの説明。	なし。
ResourceGroupId	String	リソースグループの ID。	例: `rg-bp67acfmxazb4ph****`。
NatGatewayId	String	NAT ゲートウェイの ID。	例: `ngw-bp1047e2d4z7kf2ki****`。
InternetChargeType	String	NAT ゲートウェイの計測方式。	有効な値: PayBySpec: 仕様別課金 PayByLcu: CU 別課金
BusinessStatus	String	NAT ゲートウェイのサービスステータス。	有効な値: Normal: NAT ゲートウェイは正常に動作しています。 FinancialLocked: NAT ゲートウェイは、延滞のためロックされています。
Name	String	NAT ゲートウェイの名前。	なし。
IpLists	List	NAT ゲートウェイの IP アドレス。	例: `[ { "IpAddress": "192.168.0.0", "AllocationId": "eip-bp1xyg5ipmh3nledx**", "UsingStatus": "UsedBySnatTable" }, { "IpAddress": "172.16.0.0", "AllocationId": "eip-bp19eue77u20cffjc**", "UsingStatus": "UsedByForwardTable" }]`。
ForwardTableIds	List	デスティネーションネットワークアドレス変換 (DNAT) テーブルの ID。	例: `["ftb-bp15o9aylj19vfvgt****"]`。
SnatTableIds	List	SNAT テーブルの ID。	例: `["stb-bp1tyr0o48w6wymur****"]`。
BandwidthPackageIds	List	EIP 帯域幅プランの ID。	例: `["cbwp-bp1qw2qk55oh42d5s****"]`。
FullNatTableIds	List	FULLNAT テーブルの ID。	例: `["fulltb-gw88z7hhlv43rmb26****"]`。
NatGatewayPrivateInfo	Object	拡張インターネット NAT ゲートウェイのプライベートネットワーク情報。	例: `{ "IzNo": "cn-beijing-k", "PrivateIpAddress": "192.168.0.175", "MaxBandwidth": 5120, "EniInstanceId": "eni-2ze4t2rea05cxcb4**", "EniType": "", "VswitchId": "vsw-2zetuemtyek3io2vp"}{ "IzNo": "cn-beijing-k", "PrivateIpAddress": "192.168.0.175", "MaxBandwidth": 5120, "EniInstanceId": "eni-2ze4t2rea05cxcb4", "EniType": "", "VswitchId": "vsw-2zetuemtyek3io2vp**"}`。
PrivateLinkEnabled	Boolean	NAT ゲートウェイが PrivateLink をサポートしているかどうかを示します。	有効な値: true false
PrivateLinkMode	String	PrivateLink によって使用されるモード。	有効な値: FullNat: FULLNAT モード Geneve: GENEVE モード

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Name": {
      "Type": "String",
      "Description": "NAT ゲートウェイの名前。", // The name of the NAT gateway.
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::NatGateways",
      "Properties": {
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "NatGatewayIds": {
      "Description": "NAT ゲートウェイ ID のリスト。", // The list of The nat gateway ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NatGatewayIds"
        ]
      }
    },
    "NatGateways": {
      "Description": "NAT ゲートウェイのリスト。", // The list of The nat gateways.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NatGateways"
        ]
      }
    }
  }
}