Skip to content

RouteEntries

  • Implements: com.aliyun.ros.cdk.vpc.datasource.IRouteEntries

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::RouteEntries, which is used to query routes.

Initializers

import com.aliyun.ros.cdk.vpc.datasource.RouteEntries;
RouteEntries.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .routeTableId(java.lang.String)
    .routeTableId(IResolvable)
//  .destinationCidrBlock(java.lang.String)
//  .destinationCidrBlock(IResolvable)
//  .ipVersion(java.lang.String)
//  .ipVersion(IResolvable)
//  .nextHopId(java.lang.String)
//  .nextHopId(IResolvable)
//  .nextHopType(java.lang.String)
//  .nextHopType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .routeEntryId(java.lang.String)
//  .routeEntryId(IResolvable)
//  .routeEntryName(java.lang.String)
//  .routeEntryName(IResolvable)
//  .routeEntryType(java.lang.String)
//  .routeEntryType(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.
routeTableId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeTableId: The ID of the route table.
destinationCidrBlock java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destinationCidrBlock: The destination CIDR block of the route.
ipVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipVersion: The IP version.
nextHopId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nextHopId: The ID of the next hop.
nextHopType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nextHopType: The type of the next hop.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
routeEntryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeEntryId: The ID of the route.
routeEntryName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeEntryName: The name of the route.
routeEntryType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property routeEntryType: The type of the route.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

routeTableIdRequired

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

Property routeTableId: The ID of the route table.


destinationCidrBlockOptional

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

Property destinationCidrBlock: The destination CIDR block of the route.

IPv4 and IPv6 CIDR blocks are supported.


ipVersionOptional

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

Property ipVersion: The IP version.

Valid values: IPv4: IPv4 IPv6: IPv6


nextHopIdOptional

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

Property nextHopId: The ID of the next hop.


nextHopTypeOptional

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

Property nextHopType: The type of the next hop.

Valid values: Instance (default): an Elastic Compute Service (ECS) instance HaVip: a high-availability virtual IP address (HAVIP) VpnGateway: a VPN gateway NatGateway: a NAT gateway NetworkInterface: a secondary elastic network interface (ENI) RouterInterface: a router interface IPv6Gateway: an IPv6 gateway Attachment: a transit router


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

routeEntryIdOptional

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

Property routeEntryId: The ID of the route.


routeEntryNameOptional

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

Property routeEntryName: The name of the route.


routeEntryTypeOptional

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

Property routeEntryType: The type of the route.

Valid values: Custom: a custom route System: a system route BGP: a Border Gateway Protocol (BGP) route CEN: a Cloud Enterprise Network (CEN) 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.datasource.RouteEntries;
RouteEntries.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.
attrRouteEntries java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouteEntries: The list of The route entries.
attrRouteEntryIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouteEntryIds: the list of the route entry ids.
props RouteEntriesProps 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

attrRouteEntriesRequired

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

Attribute RouteEntries: The list of The route entries.


attrRouteEntryIdsRequired

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

Attribute RouteEntryIds: the list of the route entry ids.


propsRequired

public RouteEntriesProps getProps();