ALIYUN::VPC::Ipv4Gateway - Resource Orchestration Service

ALIYUN::VPC::Ipv4Gateway is used to create an IPv4 gateway.

Syntax

{
  "Type": "ALIYUN::VPC::Ipv4Gateway",
  "Properties": {
    "Ipv4GatewayName": String,
    "VpcId": String,
    "Ipv4GatewayDescription": 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	Yes	No	The ID of the virtual private cloud (VPC) in which you want to create the IPv4 gateway.	You can create only one IPv4 gateway in a VPC.
Ipv4GatewayDescription	String	No	Yes	The description of the IPv4 gateway.	The description must be 1 to 256 characters in length. The description cannot start with `http://` or `https://`.

Return values

Fn::GetAtt

Ipv4GatewayName: the name of the IPv4 gateway.
Ipv4GatewayRouteTableId: the ID of the route table that is associated with the IPv4 gateway.
Ipv4GatewayId: the ID of the IPv4 gateway.
VpcId: the ID of the VPC in which the IPv4 gateway is created.
CreateTime: the time when the IPv4 gateway was created.
Ipv4GatewayDescription: the description of the IPv4 gateway.

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:
  ExtensionResource:
    Type: ALIYUN::VPC::Ipv4Gateway
    Properties:
      Ipv4GatewayName: TestIpv4GatewayName
      VpcId:
        Ref: VpcId
Outputs:
  Ipv4GatewayName:
    Description: Resource name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv4GatewayName
  Ipv4GatewayRouteTableId:
    Description: ID of the route table associated with IPv4 Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv4GatewayRouteTableId
  Ipv4GatewayId:
    Description: The resource attribute field that represents the resource level 1 ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv4GatewayId
  VpcId:
    Description: The ID of the VPC associated with the IPv4 Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - VpcId
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  Ipv4GatewayDescription:
    Description: Description information.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ipv4GatewayDescription

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": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::Ipv4Gateway",
      "Properties": {
        "Ipv4GatewayName": "TestIpv4GatewayName",
        "VpcId": {
          "Ref": "VpcId"
        }
      }
    }
  },
  "Outputs": {
    "Ipv4GatewayName": {
      "Description": "Resource name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv4GatewayName"
        ]
      }
    },
    "Ipv4GatewayRouteTableId": {
      "Description": "ID of the route table associated with IPv4 Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv4GatewayRouteTableId"
        ]
      }
    },
    "Ipv4GatewayId": {
      "Description": "The resource attribute field that represents the resource level 1 ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv4GatewayId"
        ]
      }
    },
    "VpcId": {
      "Description": "The ID of the VPC associated with the IPv4 Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VpcId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Ipv4GatewayDescription": {
      "Description": "Description information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ipv4GatewayDescription"
        ]
      }
    }
  }
}