DATASOURCE::VPC::NatGateways用于查询NAT网关的语法与属性-资源编排-阿里云

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网关是异步操作，在创建完成之前为正在创建状态。 Available：稳定状态。即NAT网关创建完成后的状态。 Modifying：变配状态。变配NAT网关是异步操作，在变配完成之前为变配状态。 Deleting：删除状态。删除NAT网关是异步操作，在删除完成之前为删除状态。 Converting：转换状态。普通型NAT网关转换到增强型NAT网关是异步操作，在转换完成之前为转换状态。
VpcId	String	否	是	NAT网关所属的VPC ID。	无
ZoneId	String	否	是	NAT网关所在的可用区ID。	无
ResourceGroupId	String	否	是	NAT网关所属的资源组ID。	无
InstanceChargeType	String	否	是	NAT网关实例的付费模式。	取值： PostPaid：按量付费。 PrePaid：包年包月。说明目前包年包月付费模式已停止新购。
NetworkType	String	否	是	NAT网关的类型。	取值： internet：公网NAT网关。 intranet：VPC NAT网关。
NatType	String	否	是	NAT网关的类型。	取值：Enhanced，表示增强型。
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网关是异步操作，在创建完成之前为正在创建状态。 Available：稳定状态。即NAT网关创建完成后的状态。 Modifying：变配状态。变配NAT网关是异步操作，在变配完成之前为变配状态。 Deleting：删除状态。删除NAT网关是异步操作，在删除完成之前为删除状态。 Converting：转换状态。普通型NAT网关转换到增强型NAT网关是异步操作，在转换完成之前为转换状态。
CreationTime	String	NAT网关的创建时间。	取值示例：`2021-06-08T12:20:20Z`。
VpcId	String	NAT网关所属的VPC ID。	取值示例：`vpc-bp15zckdt37pq72z****`。
NatType	String	NAT网关的类型。	取值：Enhanced，表示增强型。
Spec	String	公网NAT网关的规格。	仅当InstanceChargeType为PrePaid时该参数有效。取值： Small：小型。 Middle：中型。 Large：大型。
DeletionProtection	Boolean	是否开启删除保护功能。	取值： true：开启。 false：关闭。
NetworkType	String	NAT网关的类型。	取值： internet：公网NAT网关。 intranet：VPC NAT网关。
SecurityProtectionEnabled	Boolean	是否开启防火墙功能。	取值： true：开启。 false：关闭。
InstanceChargeType	String	NAT网关实例的付费模式。	取值： PostPaid：按量付费。 PrePaid：包年包月。说明目前包年包月付费模式已停止新购。
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：按使用量计费。
BusinessStatus	String	NAT网关的业务状态。	取值： Normal：正常。 FinancialLocked：欠费锁定状态。
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	共享带宽包的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	是否支持私网连接。	取值： true：支持。 false：不支持。
PrivateLinkMode	String	私网连接服务转化模式。	取值： FullNat：使用FULLNAT模式。 Geneve：使用Geneve模式。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Name": {
      "Type": "String",
      "Description": "The name of the NAT gateway.",
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::NatGateways",
      "Properties": {
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "NatGatewayIds": {
      "Description": "The list of The nat gateway ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NatGatewayIds"
        ]
      }
    },
    "NatGateways": {
      "Description": "The list of The nat gateways.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NatGateways"
        ]
      }
    }
  }
}