Skip to content

VpnPbrRouteEntry

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpnPbrRouteEntry.

Initializers

import com.aliyun.ros.cdk.vpc.VpnPbrRouteEntry;
VpnPbrRouteEntry.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .nextHop(java.lang.String)
    .nextHop(IResolvable)
    .publishVpc(java.lang.Boolean)
    .publishVpc(IResolvable)
    .routeDest(java.lang.String)
    .routeDest(IResolvable)
    .routeSource(java.lang.String)
    .routeSource(IResolvable)
    .vpnGatewayId(java.lang.String)
    .vpnGatewayId(IResolvable)
    .weight(java.lang.Number)
    .weight(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .overlayMode(java.lang.String)
//  .overlayMode(IResolvable)
//  .priority(java.lang.Number)
//  .priority(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
nextHop java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nextHop: The next hop of the destination route entry.
publishVpc java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property publishVpc: Indicates whether to publish the destination route to the VPC.
routeDest java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeDest: The destination CIDR block of the destination route.
routeSource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeSource: The source CIDR block of the policy-based route.
vpnGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpnGatewayId: The ID of the VPN Gateway.
weight java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property weight: The weight of the destination-based route.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the destination-based route.
overlayMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property overlayMode: The tunneling protocol.
priority java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property priority: Policy priority for policy routing.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

nextHopRequired

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

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


publishVpcRequired

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


routeDestRequired

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

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


routeSourceRequired

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

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


vpnGatewayIdRequired

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

Property vpnGatewayId: The ID of the VPN Gateway.


weightRequired

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

Property weight: The weight of the destination-based route.

Valid values:

  • 100: a high priority
  • 0: a low priority

descriptionOptional

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

Property description: The description of the destination-based route.

The description must be 1 to 100 characters in length, and cannot start with http:\/\/ or https:\/\/.


overlayModeOptional

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

Property overlayMode: The tunneling protocol.

The value is set to Ipsec, which indicates the IPsec tunneling protocol.


priorityOptional

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


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.vpc.VpnPbrRouteEntry;
VpnPbrRouteEntry.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrNextHop java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute NextHop: The next hop of the destination route entry.
attrRouteDest java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouteDest: The destination CIDR block of the destination route.
attrRouteSource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouteSource: The destination CIDR block of the policy-based route.
attrVpnGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VpnGatewayId: The ID of the VPN Gateway.
props VpnPbrRouteEntryProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrNextHopRequired

public java.lang.Object getAttrNextHop();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRouteDestRequired

public java.lang.Object getAttrRouteDest();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrRouteSourceRequired

public java.lang.Object getAttrRouteSource();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrVpnGatewayIdRequired

public java.lang.Object getAttrVpnGatewayId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpnGatewayId: The ID of the VPN Gateway.


propsRequired

public VpnPbrRouteEntryProps getProps();