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

Syntax

{
  "Type": "ALIYUN::VPC::RouterInterface",
  "Properties": {
    "OppositeRegionId": String,
    "Description": String,
    "HealthCheckSourceIp": String,
    "RouterType": String,
    "AccessPointId": String,
    "RouterId": String,
    "Role": String,
    "OppositeInterfaceOwnerId": String,
    "OppositeAccessPointId": String,
    "HealthCheckTargetIp": String,
    "OppositeRouterId": String,
    "Spec": String,
    "OppositeRouterType": String,
    "Name": String,
    "PricingCycle": String, 
    "Period": Number, 
    "AutoPay": Boolean, 
    "InstanceChargeType": String
  }
}

Properties

Name Type Required Editable Description Validity
RouterId String Yes No The ID of the router to which the router interface belongs. None
Role String Yes No The role of the router interface. A router interface can either be a connection initiator or a connection acceptor.

Valid values: InitiatingSide and AcceptingSide.

This parameter must be set to InitiatingSide when the RouterType parameter is set to VBR.

This parameter must be set to AcceptingSide when the OppositeRouterType parameter is set to VBR.

RouterType String No No The type of the router to which the router interface belongs. Valid values: VRouter and VBR.
AccessPointId String No No The ID of the access point of the router interface. This parameter is required when the RouterType parameter is set to VBR. The access point ID cannot be modified after the router interface is created. This parameter cannot be set when the RouterType parameter is set to VRouter.
Spec String No No

The specifications of the router interface.

The available specifications and the corresponding bandwidth values are as follows:
  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
  • Small.1: 10 Mbit/s
  • Small.2: 20 Mbit/s
  • Smalll.5: 50 Mbit/s
  • Middle.1: 100 Mbit/s
  • Middle.2: 200 Mbit/s
  • Middle.5: 500 Mbit/s
  • Large.1: 1000 Mbit/s
  • Large.2: 2000 Mbit/s
  • Large.5: 5000 Mbit/s
  • Xlarge.1: 10000 Mbit/s

This parameter is required when the Role parameter is set to InitiatingSide.

This parameter is automatically set to Negative when the Role parameter is set to AcceptingSide.

OppositeRegionId String No No The region ID of the peer router interface. None
OppositeInterfaceOwnerId String No No The ID of the owner of the peer router interface. The current user's ID is used by default.
OppositeRouterId String No No The ID of the router to which the peer router interface belongs. None
OppositeRouterType String No No The type of the router to which the peer router interface belongs. Valid values: VRouter and VBR. This parameter must be set to VRouter when the RouterType parameter is set to VBR.
OppositeAccessPointId String No No The ID of the access point of the peer router interface.

This parameter is required when the OppositeRouterType parameter is set to VBR. The access point ID cannot be modified after the router interface is created.

This parameter cannot be set when the OppositeRouterType parameter is set to VRouter.

When the OppositeRouterType parameter is set to VBR, the VBR specified by the OppositeRouterId parameter must be in the access point specified by the OppositeAccessPointId parameter.

Description String No No The description of the router interface. The description must be 2 to 256 characters in length. This parameter is empty by default. It cannot start with http:// or https://.
Name String No No The name of the router interface. The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens(-). It must start with a letter and cannot start with http:// or https://.
HealthCheckSourceIp String No No The source IP address of the packet used for health check in leased line disaster recovery and ECMP scenarios. This parameter is valid only for a VRouter interface with the peer router interface on a VBR. It must be an unused IP address in the VPC where the local VRouter is located. The HealthCheckSourceIp and HealthCheckTargetIp parameters must be both specified or left unspecified.
HealthCheckTargetIp String No No The destination IP address of the packet used for health check in leased line disaster recovery and ECMP scenarios. This parameter is valid only for a VRouter interface with the peer router interface on a VBR. Typically, you can use the IP address of a customer premises equipment (CPE) on the user's side of the leased line, which is the IP address of the peer gateway on the VBR where the peer router interface is located. You can also specify another IP address on the user's side of the leased line as the destination IP address. The HealthCheckSourceIp and HealthCheckTargetIp parameters must be both specified or left unspecified.
PricingCycle String No No The billing cycle of the subscription. Valid values:
  • Month: You are billed on a monthly basis.
  • Year: You are billed on a yearly basis.
Period Number No No The subscription period. Valid values:
  • Valid values when the PricingCycle parameter is set to Month: 1 to 9.
  • Valid values when the PricingCycle parameter is set to Year: 1 to 3.
AutoPay Boolean No No Specifies whether to enable automatic payment.

Valid values: true and false.

Default value: false.

InstanceChargeType String No No The billing method of the router interface. Valid values:
  • Postpaid
  • Prepaid

Response parameters

Fn::GetAtt

RouterInterfaceId: the ID of the router interface.

Examples

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "RouterInterface": {
      "Type": "ALIYUN::VPC::RouterInterface",
      "Properties": {
        "Name": "RouterInterface_1",
        "Description": "VPC initiator RouterInterface",
        "RouterId": "vrt-2ze2i147e5n0bicoefwsb",
        "Role": "AcceptingSide",
        "OppositeRegionId": "cn-beijing",
        "HealthCheckSourceIp": "10.0.0.120",
        "HealthCheckTargetIp": "192.168.1.24"
      }
    }
  },
  "Outputs": {
    "RouterInterfaceId": {
      "Value": {"Fn::GetAtt": ["RouterInterface", "RouterInterfaceId"]}
    }
  }
}