RouterInterface

This class encapsulates and extends the ROS resource type ALIYUN::VPC::RouterInterface, which is used to create a router interface.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.RouterInterface(
  scope: Construct,
  id: str,
  role: typing.Union[str, IResolvable],
  router_id: typing.Union[str, IResolvable],
  access_point_id: typing.Union[str, IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  health_check_source_ip: typing.Union[str, IResolvable] = None,
  health_check_target_ip: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  opposite_access_point_id: typing.Union[str, IResolvable] = None,
  opposite_interface_id: typing.Union[str, IResolvable] = None,
  opposite_interface_owner_id: typing.Union[str, IResolvable] = None,
  opposite_region_id: typing.Union[str, IResolvable] = None,
  opposite_router_id: typing.Union[str, IResolvable] = None,
  opposite_router_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  router_type: typing.Union[str, IResolvable] = None,
  spec: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
role	typing.Union[str, ros_cdk_core.IResolvable]	Property role: RouterInterface role.
router_id	typing.Union[str, ros_cdk_core.IResolvable]	Property routerId: The router ID to create RouterInterface.
access_point_id	typing.Union[str, ros_cdk_core.IResolvable]	Property accessPointId: Access point ID.
auto_pay	typing.Union[bool, ros_cdk_core.IResolvable]	Property autoPay: Indicates whether automatic payment is enabled.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: Custom description of the RouterInterface, [2, 256] characters.
health_check_source_ip	typing.Union[str, ros_cdk_core.IResolvable]	Property healthCheckSourceIp: Source IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
health_check_target_ip	typing.Union[str, ros_cdk_core.IResolvable]	Property healthCheckTargetIp: Target IP address of the packet for leased line HealthCheck in leased line disaster tolerance and ECMP scenarios.
instance_charge_type	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceChargeType: The billing method of the router interface.
name	typing.Union[str, 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 '.', '-'.
opposite_access_point_id	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeAccessPointId: Access point ID of the connection peer RouterInterface.
opposite_interface_id	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeInterfaceId: The ID of the peer router interface.
opposite_interface_owner_id	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeInterfaceOwnerId: Owner account ID of the connection peer RouterInterface.
opposite_region_id	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeRegionId: The region where the connection peer RouterInterface locates.
opposite_router_id	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeRouterId: The router ID of the connection peer RouterInterface.
opposite_router_type	typing.Union[str, ros_cdk_core.IResolvable]	Property oppositeRouterType: Router type of the connection peer router.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property period: Prepaid time period.
pricing_cycle	typing.Union[str, ros_cdk_core.IResolvable]	Property pricingCycle: Unit of the payment cycle.
router_type	typing.Union[str, ros_cdk_core.IResolvable]	Property routerType: Router type.
spec	typing.Union[str, ros_cdk_core.IResolvable]	Property spec: RouterInterface specification.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

role^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property role: RouterInterface role.

Now support 'InitiatingSide|AcceptingSide'.

---

router_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routerId: The router ID to create RouterInterface.

---

access_point_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accessPointId: Access point ID.

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

---

auto_pay^Optional

• Type: typing.Union[bool, 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

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

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

---

health_check_source_ip^Optional

• Type: typing.Union[str, 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.

---

health_check_target_ip^Optional

• Type: typing.Union[str, 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.

---

instance_charge_type^Optional

• Type: typing.Union[str, 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

• Type: typing.Union[str, 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 '.', '-'.

---

opposite_access_point_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

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

---

opposite_interface_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property oppositeInterfaceId: The ID of the peer router interface.

---

opposite_interface_owner_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

The default value is current user Id.

---

opposite_region_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

The default value is region where stack is created.

---

opposite_router_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

---

opposite_router_type^Optional

• Type: typing.Union[str, 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

• Type: typing.Union[typing.Union[int, float], 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.

---

pricing_cycle^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

---

router_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property routerType: Router type.

Now support 'VRouter|VBR'

---

spec^Optional

• Type: typing.Union[str, 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_vpc
ros_cdk_vpc.RouterInterface.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_router_interface_id	ros_cdk_core.IResolvable	Attribute RouterInterfaceId: The ID of created RouterInterface.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_router_interface_id^Required

attr_router_interface_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RouterInterfaceId: The ID of created RouterInterface.

---