RouterInterfaceProps

Properties for defining a RouterInterface.

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

Initializer

import com.aliyun.ros.cdk.vpc.RouterInterfaceProps;
RouterInterfaceProps.builder()
    .role(java.lang.String)
    .role(IResolvable)
    .routerId(java.lang.String)
    .routerId(IResolvable)
//  .accessPointId(java.lang.String)
//  .accessPointId(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .fastLinkMode(java.lang.Boolean)
//  .fastLinkMode(IResolvable)
//  .healthCheckSourceIp(java.lang.String)
//  .healthCheckSourceIp(IResolvable)
//  .healthCheckTargetIp(java.lang.String)
//  .healthCheckTargetIp(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .oppositeAccessPointId(java.lang.String)
//  .oppositeAccessPointId(IResolvable)
//  .oppositeInterfaceId(java.lang.String)
//  .oppositeInterfaceId(IResolvable)
//  .oppositeInterfaceOwnerId(java.lang.String)
//  .oppositeInterfaceOwnerId(IResolvable)
//  .oppositeRegionId(java.lang.String)
//  .oppositeRegionId(IResolvable)
//  .oppositeRouterId(java.lang.String)
//  .oppositeRouterId(IResolvable)
//  .oppositeRouterType(java.lang.String)
//  .oppositeRouterType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .routerType(java.lang.String)
//  .routerType(IResolvable)
//  .spec(java.lang.String)
//  .spec(IResolvable)
    .build();

Properties

role^Required

public java.lang.Object getRole();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property role: RouterInterface role.

Now support 'InitiatingSide|AcceptingSide'.

routerId^Required

public java.lang.Object getRouterId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property routerId: The router ID to create RouterInterface.

accessPointId^Optional

public java.lang.Object getAccessPointId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessPointId: Access point ID.

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

autoPay^Optional

public java.lang.Object getAutoPay();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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.

autoRenew^Optional

public java.lang.Object getAutoRenew();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Specifies whether auto-renewal is enabled.

description^Optional

public java.lang.Object getDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

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

fastLinkMode^Optional

public java.lang.Object getFastLinkMode();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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.

healthCheckSourceIp^Optional

public java.lang.Object getHealthCheckSourceIp();

• Type: java.lang.String OR com.aliyun.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.

healthCheckTargetIp^Optional

public java.lang.Object getHealthCheckTargetIp();

• Type: java.lang.String OR com.aliyun.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.

instanceChargeType^Optional

public java.lang.Object getInstanceChargeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: The billing method of the router interface.

name^Optional

public java.lang.Object getName();

• Type: java.lang.String OR com.aliyun.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^Optional

public java.lang.Object getOppositeAccessPointId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

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

oppositeInterfaceId^Optional

public java.lang.Object getOppositeInterfaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property oppositeInterfaceId: The ID of the peer router interface.

oppositeInterfaceOwnerId^Optional

public java.lang.Object getOppositeInterfaceOwnerId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

The default value is current user Id.

oppositeRegionId^Optional

public java.lang.Object getOppositeRegionId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

The default value is region where stack is created.

oppositeRouterId^Optional

public java.lang.Object getOppositeRouterId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

oppositeRouterType^Optional

public java.lang.Object getOppositeRouterType();

• Type: java.lang.String OR com.aliyun.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'.

period^Optional

public java.lang.Object getPeriod();

• Type: java.lang.Number OR com.aliyun.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.

pricingCycle^Optional

public java.lang.Object getPricingCycle();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

resourceGroupId^Optional

public java.lang.Object getResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

routerType^Optional

public java.lang.Object getRouterType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

• VRouter
• VBR

spec^Optional

public java.lang.Object getSpec();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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.