DATASOURCE::VPC::Ipv4Gateways is used to query the details of IPv4 gateways.
Syntax
{
"Type": "DATASOURCE::VPC::Ipv4Gateways",
"Properties": {
"Ipv4GatewayName": String,
"VpcId": String,
"Ipv4GatewayId": String,
"RefreshOptions": String
}
}Properties
Property | Type | Required | Editable | Description | Constraint |
Property | Type | Required | Editable | Description | Constraint |
Ipv4GatewayName | String | No | Yes | The name of the IPv4 gateway. | The name must be 1 to 128 characters in length. The name cannot start with |
VpcId | String | No | Yes | The ID of the virtual private cloud (VPC) with which the IPv4 gateway is associated. | None. |
Ipv4GatewayId | String | No | Yes | The ID of the IPv4 gateway. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
Ipv4GatewayIds: the IDs of the IPv4 gateways.
Ipv4Gateways: details of the IPv4 gateways.
Property | Type | Description | Constraint |
Ipv4GatewayIds | List | The IDs of the IPv4 gateways. | None. |
Ipv4Gateways | List | Details of the IPv4 gateways. | None. |
Status | String | The status of the IPv4 gateway. | Valid values:
|
VpcId | String | The ID of the VPC with which the IPv4 gateway is associated. | None. |
Ipv4GatewayId | String | The ID of the IPv4 gateway. | None. |
Ipv4GatewayDescription | String | The description of the IPv4 gateway. | None. |
Enabled | Boolean | Indicates whether the IPv4 gateway is activated. | Valid values:
|
Ipv4GatewayName | String | The name of the IPv4 gateway. | None. |
Ipv4GatewayRouteTableId | String | The ID of the route table associated with the IPv4 gateway. | None. |
CreateTime | String | The time when the IPv4 gateway was created. | None. |
Examples
YAML format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VpcId:
Type: String
AssociationProperty: ALIYUN::ECS::VPC::VPCId
Description: The ID of the VPC associated with the IPv4 Gateway.
Resources:
ExtensionDataSource:
Type: DATASOURCE::VPC::Ipv4Gateways
Properties:
VpcId:
Ref: VpcId
Outputs:
Ipv4GatewayIds:
Description: The list of ipv4 gateway IDs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Ipv4GatewayIds
Ipv4Gateways:
Description: The list of ipv4 gateways.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Ipv4GatewaysJSON format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
"Description": "The ID of the VPC associated with the IPv4 Gateway."
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::VPC::Ipv4Gateways",
"Properties": {
"VpcId": {
"Ref": "VpcId"
}
}
}
},
"Outputs": {
"Ipv4GatewayIds": {
"Description": "The list of ipv4 gateway IDs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Ipv4GatewayIds"
]
}
},
"Ipv4Gateways": {
"Description": "The list of ipv4 gateways.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Ipv4Gateways"
]
}
}
}
}
