DATASOURCE::VPC::Ipv4Gateways - Resource Orchestration Service

DATASOURCE::VPC::Ipv4Gateways is used to query the details of IPv4 gateways.

Syntax

{
  "Type": "DATASOURCE::VPC::Ipv4Gateways",
  "Properties": {
    "Ipv4GatewayName": String,
    "VpcId": String,
    "Ipv4GatewayId": String
  }
}

Properties

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 `http://` or `https://`.
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.

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 state of the IPv4 gateway.	Valid values: Creating: The IPv4 gateway is being created. Created: The IPv4 gateway is created and available. Modifying: The IPv4 gateway is being modified. Deleting: The IPv4 gateway is being deleted. Deleted: The IPv4 gateway is deleted.
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: true false
Ipv4GatewayName	String	The name of the IPv4 gateway.	None.
Ipv4GatewayRouteTableId	String	The ID of the route table that is 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
        - Ipv4Gateways

JSON 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"
        ]
      }
    }
  }
}