RouterInterfaceProps
Properties for defining a RouterInterface.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-routerinterface
Initializer
using AlibabaCloud.SDK.ROS.CDK.Vpc;
new RouterInterfaceProps {
object Role,
object RouterId,
object AccessPointId = null,
object AutoPay = null,
object AutoRenew = null,
object Description = null,
object FastLinkMode = null,
object HealthCheckSourceIp = null,
object HealthCheckTargetIp = null,
object InstanceChargeType = null,
object Name = null,
object OppositeAccessPointId = null,
object OppositeInterfaceId = null,
object OppositeInterfaceOwnerId = null,
object OppositeRegionId = null,
object OppositeRouterId = null,
object OppositeRouterType = null,
object Period = null,
object PricingCycle = null,
object ResourceGroupId = null,
object RouterType = null,
object Spec = null
};
Properties
| Name | Type | Description |
|---|---|---|
Role | object | Property role: RouterInterface role. |
RouterId | object | Property routerId: The router ID to create RouterInterface. |
AccessPointId | object | Property accessPointId: Access point ID. |
AutoPay | object | Property autoPay: Specifies whether to enable automatic payment. |
AutoRenew | object | Property autoRenew: Specifies whether auto-renewal is enabled. |
Description | object | Property description: Custom description of the RouterInterface, [2, 256] characters. |
FastLinkMode | object | Property fastLinkMode: Specifies whether the VBR-associated router interface is created in fast link mode. |
HealthCheckSourceIp | object | Property healthCheckSourceIp: Source IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios. |
HealthCheckTargetIp | object | Property healthCheckTargetIp: Target IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios. |
InstanceChargeType | object | Property instanceChargeType: The billing method of the router interface. |
Name | object | 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 | object | Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface. |
OppositeInterfaceId | object | Property oppositeInterfaceId: The ID of the peer router interface. |
OppositeInterfaceOwnerId | object | Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface. |
OppositeRegionId | object | Property oppositeRegionId: The region where the connection peer RouterInterface locates. |
OppositeRouterId | object | Property oppositeRouterId: The router ID of the connection peer RouterInterface. |
OppositeRouterType | object | Property oppositeRouterType: Router type of the connection peer router. |
Period | object | Property period: Prepaid time period. |
PricingCycle | object | Property pricingCycle: Unit of the payment cycle. |
ResourceGroupId | object | Property resourceGroupId: The ID of the resource group. |
RouterType | object | Property routerType: The type of router that is associated with the router interface. |
Spec | object | Property spec: The specification of the router interface and the corresponding bandwidth. |
RoleRequired
public object Role { get; set; }
- Type: object
Property role: RouterInterface role.
Now support 'InitiatingSide|AcceptingSide'.
RouterIdRequired
public object RouterId { get; set; }
- Type: object
Property routerId: The router ID to create RouterInterface.
AccessPointIdOptional
public object AccessPointId { get; set; }
- Type: object
Property accessPointId: Access point ID.
If 'RouterType' is specified as 'VBR', the value is required.
AutoPayOptional
public object AutoPay { get; set; }
- Type: object
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
public object AutoRenew { get; set; }
- Type: object
Property autoRenew: Specifies whether auto-renewal is enabled.
DescriptionOptional
public object Description { get; set; }
- Type: object
Property description: Custom description of the RouterInterface, [2, 256] characters.
Don't fill or empty, the default is empty.
FastLinkModeOptional
public object FastLinkMode { get; set; }
- Type: object
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
public object HealthCheckSourceIp { get; set; }
- Type: object
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 object HealthCheckTargetIp { get; set; }
- Type: object
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 object InstanceChargeType { get; set; }
- Type: object
Property instanceChargeType: The billing method of the router interface.
NameOptional
public object Name { get; set; }
- Type: object
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 object OppositeAccessPointId { get; set; }
- Type: object
Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.
If 'OppositeRouterType' is specified as 'VBR', the value is required.
OppositeInterfaceIdOptional
public object OppositeInterfaceId { get; set; }
- Type: object
Property oppositeInterfaceId: The ID of the peer router interface.
OppositeInterfaceOwnerIdOptional
public object OppositeInterfaceOwnerId { get; set; }
- Type: object
Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.
The default value is current user Id.
OppositeRegionIdOptional
public object OppositeRegionId { get; set; }
- Type: object
Property oppositeRegionId: The region where the connection peer RouterInterface locates.
The default value is region where stack is created.
OppositeRouterIdOptional
public object OppositeRouterId { get; set; }
- Type: object
Property oppositeRouterId: The router ID of the connection peer RouterInterface.
OppositeRouterTypeOptional
public object OppositeRouterType { get; set; }
- Type: object
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 object Period { get; set; }
- Type: object
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 object PricingCycle { get; set; }
- Type: object
Property pricingCycle: Unit of the payment cycle.
It could be Month (default) or Year.
ResourceGroupIdOptional
public object ResourceGroupId { get; set; }
- Type: object
Property resourceGroupId: The ID of the resource group.
RouterTypeOptional
public object RouterType { get; set; }
- Type: object
Property routerType: The type of router that is associated with the router interface.
Valid values:
- VRouter
- VBR
SpecOptional
public object Spec { get; set; }
- Type: object
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.