edit-icon download-icon

ALIYUN::VPC::RouterInterface

Last Updated: Jun 13, 2018

The ALIYUN::VPC::RouterInterface type is used to create a router interface.

Syntax

  1. {
  2. "Type" : "ALIYUN::VPC::RouterInterface",
  3. "Properties" : {
  4. "OppositeRegionId" : String,
  5. "Description" : String,
  6. "HealthCheckSourceIp" : String,
  7. "RouterType" : String,
  8. "AccessPointId" : String,
  9. "RouterId" : String,
  10. "Role" : String,
  11. "OppositeInterfaceOwnerId" : String,
  12. "OppositeAccessPointId" : String,
  13. "HealthCheckTargetIp" : String,
  14. "OppositeRouterId" : String,
  15. "Spec" : String,
  16. "OppositeRouterType" : String,
  17. "Name" : String
  18. }
  19. }

Attributes

Attribute name Type Required Update allowed Description Constraint
RouterId string Yes No Router ID N/A
Role string Yes No Role played in connection, that is, whether a RouterInterface is a connection initiator or a connection receiver Value options: InitiatingSide and AcceptingSide. If RouterType is set to VBR, this parameter must be set to InitiatingSide. If OppositeRouterType is set to VBR, this parameter must be set to AcceptingSide
RouterType string No No Type of the router to which a route table belongs Value options: VRouter and VBR
AccessPointId string No No Access point ID This parameter is required when RouterType is set to VBR and cannot be modified afterwards. This parameter cannot be set when RouterType is set to VRouter
Spec string No No Specifications This parameter is required if Role is set to InitiatingSide. This parameter is set to Negative by default if Role is set to AcceptingSide
OppositeRegionId string No No Region of the connection peer N/A
OppositeInterfaceOwnerId string No No Owner account ID of the connection peer RouterInterface The current user’s ID is used by default
OppositeRouterId string No No Router ID of the connection peer N/A
OppositeRouterType string No No Router type of the connection peer RouterInterface Value options: VRouter and VBR. If RouterType is set to VBR, this parameter must be set to VRouter
OppositeAccessPointId string No No Access point ID of the peer This parameter is required when OppositeRouterType is set to VBR and cannot be modified afterwards. This parameter cannot be set when OppositeRouterType is set to VRouter. When OppositeRouterType is set to VBR, the VBR specified by OppositeRouterId must be in the access point specified by OppositeAccessPointId
Description string No No Router interface description It is a string of 2 to 256 characters. The instance description is displayed on the Alibaba Cloud console. This parameter is null if not specified. It cannot start with “http://“ or “https://“
Name string No No Name of the router interface It is a string of 2 to 128 characters. It must begin with an uppercase/lowercase letter or a Chinese character and can contain English letters, Chinese characters, digits, periods(.), underscores(_), and hyphens(-). It cannot start with “http://“ or “https://“
HealthCheckSourceIp string No No Source IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios It is valid only for a VRouter RouterInterface with a peer on a VBR. The source IP address must be in the VPC of the local VRouter and is not used. HealthCheckSourceIP and HealthCheckTargetIP parameters must be both specified or left unspecified
HealthCheckTargetIp string No No Target IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios It is valid only for a VRouter RouterInterface with a peer on a VBR. Usually you can use the CPE IP address of the leased line user’s client (that is, the PeerGatewayIP on the VBR of the peer RouterInterface), you can also specify another IP address of the leased line user’s client as the HealthCheck target IP address. HealthCheckSourceIP and HealthCheckTargetIP parameters must be both specified or left unspecified

Return values

Fn::GetAtt

RouterInterfaceId: ID of the router interface.

Examples

  1. {
  2. "ROSTemplateFormatVersion" : "2015-09-01",
  3. "Resources" : {
  4. "RouterInterface": {
  5. "Type": "ALIYUN::VPC::RouterInterface",
  6. "Properties": {
  7. "Name": "RouterInterface_1",
  8. "Description": "VPC initiator RouterInterface",
  9. "RouterId": "vrt-2ze2i147e5n0bicoefwsb",
  10. "Role": "AcceptingSide",
  11. "OppositeRegionId": "cn-beijing",
  12. "HealthCheckSourceIp": "10.0.0.120",
  13. "HealthCheckTargetIp": "192.168.1.24"
  14. }
  15. }
  16. },
  17. "Outputs": {
  18. "RouterInterfaceId": {
  19. "Value": {"Fn::GetAtt": ["RouterInterface", "RouterInterfaceId"]}
  20. }
  21. }
  22. }
Thank you! We've received your feedback.