Skip to content

RouterInterfaceProps

Properties for defining a RouterInterface.

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

Initializer 

import { RouterInterfaceProps } from '@alicloud/ros-cdk-vpc'
const routerInterfaceProps: RouterInterfaceProps = { ... }

Properties

Name Type Description
role string | @alicloud/ros-cdk-core.IResolvable Property role: RouterInterface role.
routerId string | @alicloud/ros-cdk-core.IResolvable Property routerId: The router ID to create RouterInterface.
accessPointId string | @alicloud/ros-cdk-core.IResolvable Property accessPointId: Access point ID.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Indicates whether automatic payment is enabled.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Custom description of the RouterInterface, [2, 256] characters.
healthCheckSourceIp string | @alicloud/ros-cdk-core.IResolvable Property healthCheckSourceIp: Source IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
healthCheckTargetIp string | @alicloud/ros-cdk-core.IResolvable Property healthCheckTargetIp: Target IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: The billing method of the router interface.
name string | @alicloud/ros-cdk-core.IResolvable 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 string | @alicloud/ros-cdk-core.IResolvable Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.
oppositeInterfaceId string | @alicloud/ros-cdk-core.IResolvable Property oppositeInterfaceId: The ID of the peer router interface.
oppositeInterfaceOwnerId string | @alicloud/ros-cdk-core.IResolvable Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.
oppositeRegionId string | @alicloud/ros-cdk-core.IResolvable Property oppositeRegionId: The region where the connection peer RouterInterface locates.
oppositeRouterId string | @alicloud/ros-cdk-core.IResolvable Property oppositeRouterId: The router ID of the connection peer RouterInterface.
oppositeRouterType string | @alicloud/ros-cdk-core.IResolvable Property oppositeRouterType: Router type of the connection peer router.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.
pricingCycle string | @alicloud/ros-cdk-core.IResolvable Property pricingCycle: Unit of the payment cycle.
routerType string | @alicloud/ros-cdk-core.IResolvable Property routerType: Router type.
spec string | @alicloud/ros-cdk-core.IResolvable Property spec: RouterInterface specification.

roleRequired 

public readonly role: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property role: RouterInterface role.

Now support 'InitiatingSide|AcceptingSide'.

routerIdRequired 

public readonly routerId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property routerId: The router ID to create RouterInterface.

accessPointIdOptional 

public readonly accessPointId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessPointId: Access point ID.

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

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Indicates whether automatic payment is enabled.

Valid values: false: Automatic payment is disabled. You need to go to Orders to make the payment once an order is generated. true: Automatic payment is enabled. The payment is automatically made. Default: true.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

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

healthCheckSourceIpOptional 

public readonly healthCheckSourceIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 

public readonly healthCheckTargetIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: The billing method of the router interface.

Valid values: PrePaid (Subscription), PostPaid (default, Pay-As-You-Go)

nameOptional 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 

public readonly oppositeAccessPointId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

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

oppositeInterfaceIdOptional 

public readonly oppositeInterfaceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property oppositeInterfaceId: The ID of the peer router interface.

oppositeInterfaceOwnerIdOptional 

public readonly oppositeInterfaceOwnerId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

The default value is current user Id.

oppositeRegionIdOptional 

public readonly oppositeRegionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

The default value is region where stack is created.

oppositeRouterIdOptional 

public readonly oppositeRouterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

oppositeRouterTypeOptional 

public readonly oppositeRouterType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 

public readonly pricingCycle: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

routerTypeOptional 

public readonly routerType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property routerType: Router type.

Now support 'VRouter|VBR'

specOptional 

public readonly spec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property spec: RouterInterface specification.

If 'Role' is specified as 'InitiatingSide', the value is required. If 'Role' is specified as 'AcceptingSide', the value is set as 'Negative' by default.