Skip to content

VpnPbrRouteEntry

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpnPbrRouteEntry, which is used to create a policy-based route for a VPN gateway.

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.VpnPbrRouteEntry(
  scope: Construct,
  id: str,
  next_hop: typing.Union[str, IResolvable],
  publish_vpc: typing.Union[bool, IResolvable],
  route_dest: typing.Union[str, IResolvable],
  route_source: typing.Union[str, IResolvable],
  vpn_gateway_id: typing.Union[str, IResolvable],
  weight: typing.Union[typing.Union[int, float], IResolvable],
  description: typing.Union[str, IResolvable] = None,
  overlay_mode: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
next_hop typing.Union[str, ros_cdk_core.IResolvable] Property nextHop: The next hop of the destination route entry.
publish_vpc typing.Union[bool, ros_cdk_core.IResolvable] Property publishVpc: Indicates whether to publish the destination route to the VPC.
route_dest typing.Union[str, ros_cdk_core.IResolvable] Property routeDest: The destination CIDR block of the destination route.
route_source typing.Union[str, ros_cdk_core.IResolvable] Property routeSource: The source CIDR block of the policy-based route.
vpn_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnGatewayId: The ID of the VPN Gateway.
weight typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property weight: The weight of the destination route.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the VPN destination route.
overlay_mode typing.Union[str, ros_cdk_core.IResolvable] Property overlayMode: The overlay mode.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: Policy priority for policy routing.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

next_hopRequired

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

Property nextHop: The next hop of the destination route entry.

publish_vpcRequired

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

Property publishVpc: Indicates whether to publish the destination route to the VPC.

Valid values: true: Publish the destination route to the VPC. false: Do not publish the destination route to the VPC.

route_destRequired

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

Property routeDest: The destination CIDR block of the destination route.

route_sourceRequired

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

Property routeSource: The source CIDR block of the policy-based route.

vpn_gateway_idRequired

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

Property vpnGatewayId: The ID of the VPN Gateway.

weightRequired

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

Property weight: The weight of the destination route.

Valid values: 0|100.

descriptionOptional

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

Property description: The description of the VPN destination route.

overlay_modeOptional

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

Property overlayMode: The overlay mode.

priorityOptional

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

Property priority: Policy priority for policy routing.

Range: 1-100 Default value: 10. The smaller the policy priority number, the higher the priority of the policy route.

enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • 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.VpnPbrRouteEntry.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_next_hop ros_cdk_core.IResolvable Attribute NextHop: The next hop of the destination route entry.
attr_route_dest ros_cdk_core.IResolvable Attribute RouteDest: The destination CIDR block of the destination route.
attr_route_source ros_cdk_core.IResolvable Attribute RouteSource: The destination CIDR block of the policy-based route.
attr_vpn_gateway_id ros_cdk_core.IResolvable Attribute VpnGatewayId: The ID of the VPN Gateway.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_next_hopRequired 

attr_next_hop: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NextHop: The next hop of the destination route entry.

attr_route_destRequired 

attr_route_dest: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RouteDest: The destination CIDR block of the destination route.

attr_route_sourceRequired 

attr_route_source: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RouteSource: The destination CIDR block of the policy-based route.

attr_vpn_gateway_idRequired 

attr_vpn_gateway_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpnGatewayId: The ID of the VPN Gateway.