Route

• Implements: IRoute

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Route.

Initializers

import com.aliyun.ros.cdk.ecs.Route;
Route.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .destinationCidrBlock(java.lang.String)
    .destinationCidrBlock(IResolvable)
    .routeTableId(java.lang.String)
    .routeTableId(IResolvable)
//  .nextHopId(java.lang.String)
//  .nextHopId(IResolvable)
//  .nextHopList(IResolvable)
//  .nextHopList(java.util.List<IResolvable)
//  .nextHopList(NextHopListProperty>)
//  .nextHopType(java.lang.String)
//  .nextHopType(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

destinationCidrBlock^Required

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

Property destinationCidrBlock: The destination CIDR block of the custom route entry.

IPv4 CIDR blocks, IPv6 CIDR blocks, and prefix lists are supported. You must specify one of the following parameters: DestinationCidrBlock and DestinationPrefixListId. The following requirements apply:

• The destination CIDR block cannot be 100.64.0.0/10 or a subset of 100.64.0.0/10.
• The destination CIDR block of a route entry cannot be the same as the destination CIDR block of another route entry in the same route table.

routeTableId^Required

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

Property routeTableId: RouteTableId of created route entry.

nextHopId^Optional

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

Property nextHopId: The ID of the next hop.

If NextHopType is set to Ecr, you can obtain the AssociationId by

calling the DescribeExpressConnectRouterAssociation operation and use the ID as the next hop ID.

nextHopList^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListNextHopListProperty>

Property nextHopList: The route entry's next hop list.

If router is virtual border router, the value will be ignore. The list should contain 2-4 next hop. NextHopId of each next hop must be RouterInterface that VRouter forwards to VBR.

nextHopType^Optional

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

Property nextHopType: The route entry next hop type.

Valid values: Instance (default): Elastic Compute Service (ECS) instance. HaVip: High Availability Virtual IP (HAVIP). RouterInterface: Router interface. NetworkInterface: Elastic Network Interface (ENI). VpnGateway: VPN gateway. IPv6Gateway: IPv6 gateway. NatGateway: NAT gateway. Attachment: Transit router. VpcPeer: VPC peering connection. Ipv4Gateway: IPv4 gateway. GatewayEndpoint: Gateway endpoint. Ecr: Express Connect router. GatewayLoadBalancerEndpoint: Gateway Load Balancer endpoint. The default value is 'Instance'. If NextHopList is specified, this field will be ignored.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ecs.Route;
Route.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrRouteEntryId^Required

public java.lang.Object getAttrRouteEntryId();

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

Attribute RouteEntryId: The ID of the route entry.

props^Required

public RouteProps getProps();

• Type: RouteProps