ALIYUN::VPC::NatGateway類型用于創建NAT網關。
語法
{
"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網關的描述。 | 長度為2~256個字符,不能以 |
NatGatewayName | String | 否 | 否 | NAT網關的名稱。 | 長度為2~128個字符,必須以英文字母或漢字開頭,不能以 如果沒有指定該參數,默認使用網關ID作為名稱。 |
InstanceChargeType | String | 否 | 否 | NAT網關的付費模式。 | 取值:
|
PricingCycle | String | 否 | 否 | 包年包月的計費周期。 | 取值:
當InstanceChargeType取值為PrePaid時,必須指定該參數。 |
VSwitchId | String | 是 | 否 | NAT網關所屬的交換機ID。 | 創建增強型NAT網關時,您必須指定NAT網關所屬的交換機,系統會為增強型NAT網關分配一個交換機內的空閑私網IP地址。
您可以通過ListEnhanhcedNatGatewayAvailableZones接口查詢增強型NAT網關的資源可用區,通過DescribeVSwitches接口查詢交換機中的可用IP數。 |
Duration | Number | 否 | 否 | 購買時長。 | 取值:
當InstanceChargeType取值為PrePaid時,必須指定該參數。 |
DeletionProtection | Boolean | 否 | 是 | 是否開啟刪除保護功能。 | 取值:
|
InternetChargeType | String | 否 | 否 | NAT網關的計費類型。 | 取值:PayByLcu,表示按使用量計費。 |
AutoPay | Boolean | 否 | 否 | 是否開啟自動付費。 | 取值:
當InstanceChargeType取值為PrePaid時,必須指定該參數。 |
NatType | String | 否 | 否 | NAT網關的類型。 | 取值:Enhanced,表示增強型NAT網關。 |
DeletionForce | Boolean | 否 | 否 | 是否強制刪除NAT網關。 | 取值:
|
VpcId | String | 是 | 否 | 需要創建NAT網關的專有網絡ID。 | 如果您要創建的NAT網關類型為普通型NAT網關,請確保專有網絡路由表中沒有目標網段為0.0.0.0/0的路由條目。否則,請先刪除該路由條目。 說明 如果您創建的NAT網關類型是增強型NAT網關,則無此限制。 |
NetworkType | String | 否 | 否 | NAT網關的網絡類型。 | 取值:
|
Tags | List | 否 | 是 | 標簽。 | 最多可綁定20個標簽。 |
EipBindMode | String | 否 | 否 | NAT網關的EIP綁定模式。 | 取值:
|
IcmpReplyEnabled | Boolean | 否 | 否 | 是否開啟ICMP不代回功能。 | 取值:
|
SecurityProtectionEnabled | Boolean | 否 | 否 | 是否開啟防火墻功能。 | 取值:
|
Tags語法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標簽鍵。 | 長度為1~64個字符,必須以英文字母或漢字開頭,不能以 |
Value | String | 否 | 否 | 標簽值。 | 長度為0~128個字符,必須以英文字母或漢字開頭,不能以 |
返回值
Fn::GetAtt
NatGatewayId:NAT網關ID。
SNatTableId:SNAT條目ID。
ForwardTableId:DNAT條目ID。
示例
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
{
"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"
]
}
}
}
}