ALIYUN::ECS::NatGateway は、VPC に NAT ゲートウェイを作成するために使用されます。
構文
{
"Type": "ALIYUN::ECS::NatGateway",
"Properties": {
"DeletionProtection": Boolean,
"VpcId": String,
"Description": String,
"NatGatewayName": String,
"NatType": String,
"Duration": Number,
"AutoPay": Boolean,
"InstanceChargeType": String,
"PricingCycle": String,
"VSwitchId": String,
"DeletionForce": Boolean,
"Spec": String,
"Tags": List,
"EipBindMode": String
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
VpcId | String | はい | いいえ | NAT ゲートウェイを作成する VPC の ID。 | なし。 |
VSwitchId | String | いいえ | いいえ | VPC 内の vSwitch の ID。 | なし。 |
Description | String | いいえ | いいえ | NAT ゲートウェイの説明。 | 説明は 2~256 文字である必要があります。 |
NatGatewayName | String | いいえ | いいえ | NAT ゲートウェイの名前。 | 名前は 2~128 文字で、文字、数字、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。先頭は文字である必要があります。 |
NatType | String | いいえ | いいえ | NAT ゲートウェイのタイプ。 | 有効な値:
|
Duration | Number | いいえ | いいえ | サブスクリプション期間。 | 有効な値:
説明 このプロパティは、InstanceChargeType が PrePaid に設定されている場合に指定する必要があります。 |
AutoPay | Boolean | いいえ | いいえ | 自動支払いを有効にするかどうかを指定します。 | 有効な値:
説明 このプロパティは、InstanceChargeType が PrePaid に設定されている場合に指定する必要があります。 |
InstanceChargeType | String | いいえ | いいえ | 課金方法。 | 有効な値:
|
PricingCycle | String | いいえ | いいえ | サブスクリプション期間の単位。 | 有効な値:
説明 このプロパティは、InstanceChargeType が PrePaid に設定されている場合に指定する必要があります。 |
Spec | String | いいえ | いいえ | インターネット NAT ゲートウェイのサイズ。 | 有効な値:
|
DeletionProtection | Boolean | いいえ | いいえ | 削除保護を有効にするかどうかを指定します。 | 有効な値:
|
DeletionForce | Boolean | いいえ | いいえ | SNAT および DNAT エントリを強制的に削除し、NAT ゲートウェイから Elastic IP アドレス (EIP) の関連付けを解除するかどうかを指定します。 | 有効な値:
|
Tags | List | いいえ | いいえ | タグ。 | 最大 20 個のタグを追加できます。 詳細については、「Tags プロパティ」をご参照ください。 |
EipBindMode | String | いいえ | いいえ | NAT ゲートウェイを EIP に関連付けるモード。 | 有効な値:
|
Tags 構文
"Tags": [
{
"Key": String,
"Value": String
}
] Tags プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Key | String | はい | いいえ | タグのキー。 | キーは 1~128 文字で、 |
Value | String | いいえ | いいえ | タグの値。 | 値は最大 128 文字で、 |
戻り値
Fn::GetAtt
ForwardTableId: ポート転送テーブルの ID。
SNatTableId: SNAT テーブルの ID。
NatGatewayId: NAT ゲートウェイの一意の ID。
BandwidthPackageIps: インターネット共有帯域幅インスタンスの IP アドレス。
BandwidthPackageIds: インターネット共有帯域幅インスタンスの ID。
例
JSON フォーマット
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"Description": {
"Type": "String",
"Description": "NAT ゲートウェイの説明、[2, 256] 文字。入力しないか空のままにすると、デフォルトは空になります。"
},
"NatGatewayName": {
"Type": "String",
"Description": "NAT ゲートウェイの表示名、[2, 128] 文字の英語または中国語。先頭は文字または中国語である必要があり、数字、'_'、'.'、'-' を含めることができます。"
},
"InstanceChargeType": {
"Type": "String",
"Description": "課金方法。デフォルト値は PostPaid (従量課金) です。",
"AllowedValues": [
"PrePaid",
"PostPaid"
],
"Default": "PostPaid"
},
"PricingCycle": {
"Type": "String",
"Description": "リソースの料金サイクル。このプロパティにはデフォルト値がありません。",
"AllowedValues": [
"Month",
"Year"
]
},
"VSwitchId": {
"Type": "String",
"Description": "NAT ゲートウェイを作成する VSwitch の ID。"
},
"Duration": {
"Type": "Number",
"Description": "サブスクリプション期間。月払いの場合は 1~9、年払いの場合は 1~3 を選択できます。",
"MinValue": 1,
"MaxValue": 9,
"Default": 1
},
"DeletionProtection": {
"Type": "Boolean",
"Description": "削除保護を有効にするかどうか。\nデフォルトは False です。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"AutoPay": {
"Type": "Boolean",
"Description": "自動支払いを有効にするかどうかを指定します。デフォルトは false です。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"NatType": {
"Type": "String",
"Description": "NAT ゲートウェイのタイプ。有効な値:\n- Normal: 基本 NAT ゲートウェイ。\n- Enhanced: 拡張 NAT ゲートウェイ。",
"AllowedValues": [
"Normal",
"Enhanced"
]
},
"DeletionForce": {
"Type": "Boolean",
"Description": "NAT ゲートウェイ内の関連する snat および dnat エントリを強制的に削除し、eip のバインドを解除するかどうか。デフォルト値は false です。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"VpcId": {
"Type": "String",
"Description": "NAT ゲートウェイを作成する VPC の ID。"
},
"Spec": {
"Type": "String",
"Description": "NAT ゲートウェイの仕様。現在 'Small|Middle|Large|XLarge.1' をサポートしています。"
},
"Tags": {
"Type": "Json",
"Description": "natgateway にアタッチするタグ。natgateway の作成時に最大 20 個のタグを追加できます。各タグには Key と Value の 2 つのプロパティがあり、Key は必須です。",
"MaxLength": 20
}
},
"Resources": {
"NatGateway": {
"Type": "ALIYUN::ECS::NatGateway",
"Properties": {
"Description": {
"Ref": "Description"
},
"NatGatewayName": {
"Ref": "NatGatewayName"
},
"InstanceChargeType": {
"Ref": "InstanceChargeType"
},
"PricingCycle": {
"Ref": "PricingCycle"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"Duration": {
"Ref": "Duration"
},
"DeletionProtection": {
"Ref": "DeletionProtection"
},
"AutoPay": {
"Ref": "AutoPay"
},
"NatType": {
"Ref": "NatType"
},
"DeletionForce": {
"Ref": "DeletionForce"
},
"VpcId": {
"Ref": "VpcId"
},
"Spec": {
"Ref": "Spec"
},
"Tags": {
"Ref": "Tags"
}
}
}
},
"Outputs": {
"BandwidthPackageIds": {
"Description": "作成された NAT ゲートウェイの帯域幅パッケージ ID。",
"Value": {
"Fn::GetAtt": [
"NatGateway",
"BandwidthPackageIds"
]
}
},
"NatGatewayId": {
"Description": "作成された NAT ゲートウェイの ID。",
"Value": {
"Fn::GetAtt": [
"NatGateway",
"NatGatewayId"
]
}
},
"SNatTableId": {
"Description": "SNAT テーブルの ID。",
"Value": {
"Fn::GetAtt": [
"NatGateway",
"SNatTableId"
]
}
},
"BandwidthPackageIps": {
"Description": "割り当てられたパブリック IP。",
"Value": {
"Fn::GetAtt": [
"NatGateway",
"BandwidthPackageIps"
]
}
},
"ForwardTableId": {
"Description": "転送テーブルの ID。",
"Value": {
"Fn::GetAtt": [
"NatGateway",
"ForwardTableId"
]
}
}
}
}YAML フォーマット
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Description:
Type: String
Description: >-
NAT ゲートウェイの説明、[2, 256] 文字。入力しないか空のままにすると、
デフォルトは空になります。
NatGatewayName:
Type: String
Description: >-
NAT ゲートウェイの表示名、[2, 128] 文字の英語または中国語。
先頭は文字または中国語である必要があり、数字、'_'、
'.'、'-' を含めることができます。
InstanceChargeType:
Type: String
Description: >-
課金方法。デフォルト値は PostPaid (
従量課金) です。
AllowedValues:
- PrePaid
- PostPaid
Default: PostPaid
PricingCycle:
Type: String
Description: リソースの料金サイクル。このプロパティにはデフォルト値がありません。
AllowedValues:
- Month
- Year
VSwitchId:
Type: String
Description: NAT ゲートウェイを作成する VSwitch の ID。
Duration:
Type: Number
Description: >-
サブスクリプション期間。月払いの場合は
1~9、年払いの場合は 1~3 を選択できます。
MinValue: 1
MaxValue: 9
Default: 1
DeletionProtection:
Type: Boolean
Description: |-
削除保護を有効にするかどうか。
デフォルトは False です。
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
AutoPay:
Type: Boolean
Description: 自動支払いを有効にするかどうかを指定します。デフォルトは false です。
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
NatType:
Type: String
Description: |-
NAT ゲートウェイのタイプ。有効な値:
- Normal: 基本 NAT ゲートウェイ。
- Enhanced: 拡張 NAT ゲートウェイ。
AllowedValues:
- Normal
- Enhanced
DeletionForce:
Type: Boolean
Description: >-
NAT ゲートウェイ内の関連する snat および dnat エントリを強制的に削除し、
eip のバインドを解除するかどうか。デフォルト値は false です。
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
VpcId:
Type: String
Description: NAT ゲートウェイを作成する VPC の ID。
Spec:
Type: String
Description: NAT ゲートウェイの仕様。現在 'Small|Middle|Large|XLarge.1' をサポートしています。
Tags:
Type: Json
Description: >-
natgateway にアタッチするタグ。natgateway の作成時に最大 20 個の
タグを追加できます。各タグには Key と Value の 2 つのプロパティがあり、Key は
必須です。
MaxLength: 20
Resources:
NatGateway:
Type: 'ALIYUN::ECS::NatGateway'
Properties:
Description:
Ref: Description
NatGatewayName:
Ref: NatGatewayName
InstanceChargeType:
Ref: InstanceChargeType
PricingCycle:
Ref: PricingCycle
VSwitchId:
Ref: VSwitchId
Duration:
Ref: Duration
DeletionProtection:
Ref: DeletionProtection
AutoPay:
Ref: AutoPay
NatType:
Ref: NatType
DeletionForce:
Ref: DeletionForce
VpcId:
Ref: VpcId
Spec:
Ref: Spec
Tags:
Ref: Tags
Outputs:
BandwidthPackageIds:
Description: 作成された NAT ゲートウェイの帯域幅パッケージ ID。
Value:
'Fn::GetAtt':
- NatGateway
- BandwidthPackageIds
NatGatewayId:
Description: 作成された NAT ゲートウェイの ID。
Value:
'Fn::GetAtt':
- NatGateway
- NatGatewayId
SNatTableId:
Description: SNAT テーブルの ID。
Value:
'Fn::GetAtt':
- NatGateway
- SNatTableId
BandwidthPackageIps:
Description: 割り当てられたパブリック IP。
Value:
'Fn::GetAtt':
- NatGateway
- BandwidthPackageIps
ForwardTableId:
Description: 転送テーブルの ID。
Value:
'Fn::GetAtt':
- NatGateway
- ForwardTableId