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)
//  .description(java.lang.String)
//  .description(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)
//  .routerType(java.lang.String)
//  .routerType(IResolvable)
//  .spec(java.lang.String)
//  .spec(IResolvable)
    .build();

Properties

Name	Type	Description
role	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property role: RouterInterface role.
routerId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property routerId: The router ID to create RouterInterface.
accessPointId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property accessPointId: Access point ID.
autoPay	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property autoPay: Indicates whether automatic payment is enabled.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Custom description of the RouterInterface, [2, 256] characters.
healthCheckSourceIp	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.
healthCheckTargetIp	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.
instanceChargeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceChargeType: The billing method of the router interface.
name	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	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.
oppositeInterfaceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeInterfaceId: The ID of the peer router interface.
oppositeInterfaceOwnerId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.
oppositeRegionId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeRegionId: The region where the connection peer RouterInterface locates.
oppositeRouterId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeRouterId: The router ID of the connection peer RouterInterface.
oppositeRouterType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property oppositeRouterType: Router type of the connection peer router.
period	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property period: Prepaid time period.
pricingCycle	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property pricingCycle: Unit of the payment cycle.
routerType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property routerType: Router type.
spec	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property spec: RouterInterface specification.

---

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

---

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.

---

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.

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

---

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.

---

routerType^Optional

public java.lang.Object getRouterType();

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

Property routerType: Router type.

Now support 'VRouter|VBR'

---

spec^Optional

public java.lang.Object getSpec();

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

---