全部產品
Search
文件中心

:ALIYUN::VPC::NatGateway

更新時間:Jun 19, 2024

ALIYUN::VPC::NatGateway類型用於建立NAT Gateway。

文法

{
  "Type": "ALIYUN::VPC::NatGateway",
  "Properties": {
    "Description": String,
    "NatGatewayName": String,
    "InstanceChargeType": String,
    "PricingCycle": String,
    "VSwitchId": String,
    "Duration": Number,
    "DeletionProtection": Boolean,
    "InternetChargeType": String,
    "AutoPay": Boolean,
    "NatType": String,
    "DeletionForce": Boolean,
    "VpcId": String,
    "Tags": List,
    "NetworkType": String,
    "EipBindMode": String,
    "IcmpReplyEnabled": Boolean,
    "SecurityProtectionEnabled": Boolean
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

Description

String

NAT Gateway的描述。

長度為2~256個字元,不能以http://https://開頭。

NatGatewayName

String

NAT Gateway的名稱。

長度為2~128個字元,必須以英文字母或漢字開頭,不能以http://https://開頭。可包含英文字母、漢字、數字、半形句號(.)、底線(_)和短劃線(-)。

如果沒有指定該參數,預設使用網關ID作為名稱。

InstanceChargeType

String

NAT Gateway的付費模式。

取值:

  • PostPaid(預設值):隨用隨付。

  • PrePaid:訂用帳戶。

PricingCycle

String

訂用帳戶的計費周期。

取值:

  • Month(預設值):月付型。

  • Year:按年付費。

當InstanceChargeType取值為PrePaid時,必須指定該參數。

VSwitchId

String

NAT Gateway所屬的交換器ID。

建立增強型NAT Gateway時,您必須指定NAT Gateway所屬的交換器,系統會為增強型NAT Gateway分配一個交換器內的空閑私網IP地址。

  • 如果您要在存量交換器中建立增強型NAT Gateway,請確保交換器所屬的可用性區域支援建立增強型NAT Gateway,且交換器有可用的IP。

  • 如果您還未建立交換器,請先在支援建立增強型NAT Gateway的可用性區域建立交換器,然後再指定增強型NAT Gateway所屬的交換器。

您可以通過ListEnhanhcedNatGatewayAvailableZones介面查詢增強型NAT Gateway的資源可用性區域,通過DescribeVSwitches介面查詢交換器中的可用IP數。

Duration

Number

購買時間長度。

取值:

  • 當PricingCycle取值Month時:1~9。

  • 當PricingCycle取值Year時:1~3。

當InstanceChargeType取值為PrePaid時,必須指定該參數。

DeletionProtection

Boolean

是否開啟刪除保護功能。

取值:

  • true:開啟刪除保護功能。

  • false:關閉刪除保護功能。

InternetChargeType

String

NAT Gateway的計費類型。

取值:PayByLcu,表示按使用量計費。

AutoPay

Boolean

是否開啟自動付費。

取值:

  • false:關閉自動付費,產生訂單後需要到訂單中心完成支付。

  • true(預設值):開啟自動付費,自動支付訂單。

當InstanceChargeType取值為PrePaid時,必須指定該參數。

NatType

String

NAT Gateway的類型。

取值:Enhanced,表示增強型NAT Gateway。

DeletionForce

Boolean

是否強制移除NAT Gateway。

取值:

  • true:強制移除。

  • false:不強制移除。

VpcId

String

需要建立NAT Gateway的專用網路ID。

如果您要建立的NAT Gateway類型為普通型NAT Gateway,請確保專用網路路由表中沒有目標網段為0.0.0.0/0的路由條目。否則,請先刪除該路由條目。

說明

如果您建立的NAT Gateway類型是增強型NAT Gateway,則無此限制。

NetworkType

String

NAT Gateway的網路類型。

取值:

  • Internet(預設值):公網NAT Gateway。

  • Intranet:私網NAT Gateway。

Tags

List

標籤。

最多可綁定20個標籤。

更多資訊,請參見Tags文法Tags屬性

EipBindMode

String

NAT Gateway的EIP繫結模式。

取值:

  • MULTI_BINDED(預設值):多EIP網卡可見度模式。

  • NAT:EIP普通模式,相容IPv4網關。

    當NAT Gateway的EIP繫結模式為EIP普通模式時,NAT Gateway支援綁定的EIP數量上限為50個,且EIP將佔用NAT Gateway所在交換器的一個私網IP。

    說明

    當NAT Gateway所在的交換器沒有可用的空閑私網地址時,NAT Gateway將無法綁定新的EIP。

IcmpReplyEnabled

Boolean

是否開啟ICMP不代回功能。

取值:

  • true:開啟ICMP不代回功能。

  • false(預設值):不開啟ICMP不代回功能。

SecurityProtectionEnabled

Boolean

是否開啟防火牆功能。

取值:

  • true:開啟防火牆功能。

  • false(預設值):不開啟防火牆功能。

Tags文法

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

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Key

String

標籤鍵。

長度為1~64個字元,必須以英文字母或漢字開頭,不能以aliyunacs:開頭,不能包含http://https://。可包含英文字母、漢字、數字、半形句號(.)、底線(_)和短劃線(-)。

Value

String

標籤值。

長度為0~128個字元,必須以英文字母或漢字開頭,不能以aliyunacs:開頭,不能包含http://https://。可包含英文字母、漢字、數字、半形句號(.)、底線(_)和短劃線(-)。

傳回值

Fn::GetAtt

  • NatGatewayId:NAT GatewayID。

  • SNatTableId:SNAT條目ID。

  • ForwardTableId:DNAT條目ID。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Description: Test ECS NatGateway
Parameters:
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Label:
      zh-cn: 現有VPC的執行個體ID
      en: Existing VPC Instance ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Label:
      zh-cn: 網路交換器ID
      en: VSwitch ID
    AssociationPropertyMetadata:
      VpcId: VPC
Resources:
  NatGateway:
    Type: ALIYUN::VPC::NatGateway
    Properties:
      NatGatewayName: mytest
      VpcId:
        Ref: VPC
      VSwitchId:
        Ref: VSwitch
Outputs:
  NatGatewayId:
    Value:
      Fn::GetAtt:
        - NatGateway
        - NatGatewayId
  BandwidthPackageId:
    Value:
      Fn::GetAtt:
        - BandwidthPackage
        - BandwidthPackageId
  BandwidthPackageIps:
    Value:
      Fn::GetAtt:
        - CommonBandwidthPackageIp
        - IpAddresses

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ECS NatGateway",
  "Parameters": {
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Label": {
        "zh-cn": "現有VPC的執行個體ID",
        "en": "Existing VPC Instance ID"
      }
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Label": {
        "zh-cn": "網路交換器ID",
        "en": "VSwitch ID"
      },
      "AssociationPropertyMetadata": {
        "VpcId": "VPC"
      }
    }
  },
  "Resources": {
    "NatGateway": {
      "Type": "ALIYUN::VPC::NatGateway",
      "Properties": {
        "NatGatewayName": "mytest",
        "VpcId": {
          "Ref": "VPC"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        }
      }
    }
  },
  "Outputs": {
    "NatGatewayId": {
      "Value": {
        "Fn::GetAtt": [
          "NatGateway",
          "NatGatewayId"
        ]
      }
    },
    "BandwidthPackageId": {
      "Value": {
        "Fn::GetAtt": [
          "BandwidthPackage",
          "BandwidthPackageId"
        ]
      }
    },
    "BandwidthPackageIps": {
      "Value": {
        "Fn::GetAtt": [
          "CommonBandwidthPackageIp",
          "IpAddresses"
        ]
      }
    }
  }
}