DATASOURCE::VPC::NatGateways is used to query NAT gateways.
Syntax
{
"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
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
Status | String | No | Yes | The state of the NAT gateway. | Valid values:
|
VpcId | String | No | Yes | The ID of the virtual private cloud (VPC) where the NAT gateway is deployed. | None. |
ZoneId | String | No | Yes | The ID of the zone to which the NAT gateway belongs. | None. |
ResourceGroupId | String | No | Yes | The ID of the resource group to which the NAT gateway belongs. | None. |
InstanceChargeType | String | No | Yes | The billing method of the NAT gateway. | Valid values:
|
NetworkType | String | No | Yes | The network type of the NAT gateway. | Valid values:
|
NatType | String | No | Yes | The type of the NAT gateway. | Set the value to Enhanced, which specifies an enhanced NAT gateway. |
NatGatewayId | String | No | Yes | The ID of the NAT gateway. | None. |
Name | String | No | Yes | The name of the NAT gateway. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values (Fn::GetAtt)
NatGatewayIds: the IDs of the NAT gateways.
NatGateways: details of the NAT gateways.
Property | Type | Description | Constraint |
NatGatewayIds | List | The IDs of the NAT gateways. | Example: |
NatGateways | List | Details of the NAT gateways. | None. |
Status | String | The state of the NAT gateway. | Valid values:
|
CreationTime | String | The time when the NAT gateway was created. | Example: |
VpcId | String | The ID of the VPC where the NAT gateway is deployed. | Example: |
NatType | String | The type of the NAT gateway. | The value Enhanced is returned for this property. This value indicates an enhanced NAT gateway. |
Spec | String | The specification of the Internet NAT gateway. | This property takes effect only when InstanceChargeType is set to PrePaid. Valid values:
|
DeletionProtection | Boolean | Indicates whether deletion protection is enabled. | Valid values:
|
NetworkType | String | The network type of the NAT gateway. | Valid values:
|
SecurityProtectionEnabled | Boolean | Indicates whether the security protection feature is enabled. | Valid values:
|
InstanceChargeType | String | The billing method of the NAT gateway. | Valid values:
|
EcsMetricEnabled | Boolean | Indicates whether the traffic monitoring feature is enabled. | Valid values:
|
IcmpReplyEnabled | Boolean | Indicates whether the Internet control message protocol (ICMP) non-retrieval feature is enabled. | Valid values:
|
Description | String | The description of the NAT gateway. | None. |
ResourceGroupId | String | The ID of the resource group. | Example: |
NatGatewayId | String | The ID of the NAT gateway. | Example: |
InternetChargeType | String | The metering method of the NAT gateway. | Valid values:
|
BusinessStatus | String | The service status of the NAT gateway. | Valid values:
|
Name | String | The name of the NAT gateway. | None. |
IpLists | List | The IP addresses of the NAT gateways. | Example: |
ForwardTableIds | List | The ID of the Destination Network Address Translation (DNAT) table. | Example: |
SnatTableIds | List | The ID of the SNAT table. | Example: |
BandwidthPackageIds | List | The ID of the EIP bandwidth plan. | Example: |
FullNatTableIds | List | The ID of the FULLNAT table. | Example: |
NatGatewayPrivateInfo | Object | The private network information of the enhanced Internet NAT gateway. | Example: |
PrivateLinkEnabled | Boolean | Indicates whether the NAT gateway supports PrivateLink. | Valid values:
|
PrivateLinkMode | String | The mode that is used by PrivateLink. | Valid values:
|
Examples
JSON
format
{
"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"
]
}
}
}
}