Skip to content

RouterInterfaceProps

Properties for defining a RouterInterface.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-routerinterface

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkvpc"
&alicloudroscdkvpc.RouterInterfaceProps {
    Role: interface{},
    RouterId: interface{},
    AccessPointId: interface{},
    AutoPay: interface{},
    AutoRenew: interface{},
    Description: interface{},
    FastLinkMode: interface{},
    HealthCheckSourceIp: interface{},
    HealthCheckTargetIp: interface{},
    InstanceChargeType: interface{},
    Name: interface{},
    OppositeAccessPointId: interface{},
    OppositeInterfaceId: interface{},
    OppositeInterfaceOwnerId: interface{},
    OppositeRegionId: interface{},
    OppositeRouterId: interface{},
    OppositeRouterType: interface{},
    Period: interface{},
    PricingCycle: interface{},
    ResourceGroupId: interface{},
    RouterType: interface{},
    Spec: interface{},
}

Properties

Name Type Description
Role interface{} Property role: RouterInterface role.
RouterId interface{} Property routerId: The router ID to create RouterInterface.
AccessPointId interface{} Property accessPointId: Access point ID.
AutoPay interface{} Property autoPay: Specifies whether to enable automatic payment.
AutoRenew interface{} Property autoRenew: Specifies whether auto-renewal is enabled.
Description interface{} Property description: Custom description of the RouterInterface, [2, 256] characters.
FastLinkMode interface{} Property fastLinkMode: Specifies whether the VBR-associated router interface is created in fast link mode.
HealthCheckSourceIp interface{} Property healthCheckSourceIp: Source IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
HealthCheckTargetIp interface{} Property healthCheckTargetIp: Target IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
InstanceChargeType interface{} Property instanceChargeType: The billing method of the router interface.
Name interface{} Property name: Custom name of the RouterInterface, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
OppositeAccessPointId interface{} Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.
OppositeInterfaceId interface{} Property oppositeInterfaceId: The ID of the peer router interface.
OppositeInterfaceOwnerId interface{} Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.
OppositeRegionId interface{} Property oppositeRegionId: The region where the connection peer RouterInterface locates.
OppositeRouterId interface{} Property oppositeRouterId: The router ID of the connection peer RouterInterface.
OppositeRouterType interface{} Property oppositeRouterType: Router type of the connection peer router.
Period interface{} Property period: Prepaid time period.
PricingCycle interface{} Property pricingCycle: Unit of the payment cycle.
ResourceGroupId interface{} Property resourceGroupId: The ID of the resource group.
RouterType interface{} Property routerType: The type of router that is associated with the router interface.
Spec interface{} Property spec: The specification of the router interface and the corresponding bandwidth.

RoleRequired

Role interface{}
  • Type: interface{}

Property role: RouterInterface role.

Now support 'InitiatingSide|AcceptingSide'.


RouterIdRequired

RouterId interface{}
  • Type: interface{}

Property routerId: The router ID to create RouterInterface.


AccessPointIdOptional

AccessPointId interface{}
  • Type: interface{}

Property accessPointId: Access point ID.

If 'RouterType' is specified as 'VBR', the value is required.


AutoPayOptional

AutoPay interface{}
  • Type: interface{}

Property autoPay: Specifies whether to enable automatic payment.

Valid values:

  • false (default): The automatic payment is disabled. If you select this option, you must go to the Order Center to complete the payment after an order is generated.
  • true: The automatic payment is enabled. Payments are automatically complete after an order is generated.

This parameter is required if InstanceChargeType is set to PrePaid.


AutoRenewOptional

AutoRenew interface{}
  • Type: interface{}

Property autoRenew: Specifies whether auto-renewal is enabled.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: Custom description of the RouterInterface, [2, 256] characters.

Don't fill or empty, the default is empty.


FastLinkModeOptional

FastLinkMode interface{}
  • Type: interface{}

Property fastLinkMode: Specifies whether the VBR-associated router interface is created in fast link mode.

Fast link mode allows the router interfaces between VBR and VPC ends to be automatically connected after they are created. This parameter is valid only when the value of RouterType is VBR and the value of OppositeRouterType is VRouter.

  • When the value of the FastLinkMode parameter is true, the value of the Role parameter must be InitiatingSide, and the AccessPointId, OppositeRouterType, OppsiteRouterId, and OppositeInterfaceOwnerId parameters are required.

HealthCheckSourceIpOptional

HealthCheckSourceIp interface{}
  • Type: interface{}

Property healthCheckSourceIp: 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.


HealthCheckTargetIpOptional

HealthCheckTargetIp interface{}
  • Type: interface{}

Property healthCheckTargetIp: 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.


InstanceChargeTypeOptional

InstanceChargeType interface{}
  • Type: interface{}

Property instanceChargeType: The billing method of the router interface.


NameOptional

Name interface{}
  • Type: interface{}

Property name: Custom name of the RouterInterface, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.


OppositeAccessPointIdOptional

OppositeAccessPointId interface{}
  • Type: interface{}

Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.

If 'OppositeRouterType' is specified as 'VBR', the value is required.


OppositeInterfaceIdOptional

OppositeInterfaceId interface{}
  • Type: interface{}

Property oppositeInterfaceId: The ID of the peer router interface.


OppositeInterfaceOwnerIdOptional

OppositeInterfaceOwnerId interface{}
  • Type: interface{}

Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.

The default value is current user Id.


OppositeRegionIdOptional

OppositeRegionId interface{}
  • Type: interface{}

Property oppositeRegionId: The region where the connection peer RouterInterface locates.

The default value is region where stack is created.


OppositeRouterIdOptional

OppositeRouterId interface{}
  • Type: interface{}

Property oppositeRouterId: The router ID of the connection peer RouterInterface.


OppositeRouterTypeOptional

OppositeRouterType interface{}
  • Type: interface{}

Property oppositeRouterType: Router type of the connection peer router.

Now support 'VRouter|VBR'. If 'RouterType' is specified as 'VBR', the value must be 'VRouter'.


PeriodOptional

Period interface{}
  • Type: interface{}

Property period: Prepaid time period.

It could be from 1 to 9 when PricingCycle is Month, or 1 to 3 when PricingCycle is Year.


PricingCycleOptional

PricingCycle interface{}
  • Type: interface{}

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.


ResourceGroupIdOptional

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.


RouterTypeOptional

RouterType interface{}
  • Type: interface{}

Property routerType: The type of router that is associated with the router interface.

Valid values:

  • VRouter
  • VBR

SpecOptional

Spec interface{}
  • Type: interface{}

Property spec: The specification of the router interface and the corresponding bandwidth.

Valid values:

  • Mini.2: 2 Mbit/s
  • Mini.5: 5 Mbit/s
  • Small.1: 10 Mbit/s
  • Small.2: 20 Mbit/s
  • Small.5: 50 Mbit/s
  • Middle.1: 100 Mbit/s
  • Middle.2: 200 Mbit/s
  • Middle.5: 500 Mbit/s
  • Large.1: 1,000 Mbit/s
  • Large.2: 2,000 Mbit/s
  • Large.5: 5,000 Mbit/s
  • Xlarge.1: 10,000 Mbit/s

If Role is set to AcceptingSide, set Spec to Negative. This indicates that you do not need to specify the specification when you create an acceptor router interface.