pulumi-alicloud-kotlin/com.pulumi.alicloud.cen.kotlin/RouteMapArgs

RouteMapArgs

data class RouteMapArgs(val asPathMatchMode: Output<String>? = null, val cenId: Output<String>? = null, val cenRegionId: Output<String>? = null, val cidrMatchMode: Output<String>? = null, val communityMatchMode: Output<String>? = null, val communityOperateMode: Output<String>? = null, val description: Output<String>? = null, val destinationChildInstanceTypes: Output<List<String>>? = null, val destinationCidrBlocks: Output<List<String>>? = null, val destinationInstanceIds: Output<List<String>>? = null, val destinationInstanceIdsReverseMatch: Output<Boolean>? = null, val destinationRouteTableIds: Output<List<String>>? = null, val mapResult: Output<String>? = null, val matchAsns: Output<List<String>>? = null, val matchCommunitySets: Output<List<String>>? = null, val nextPriority: Output<Int>? = null, val operateCommunitySets: Output<List<String>>? = null, val preference: Output<Int>? = null, val prependAsPaths: Output<List<String>>? = null, val priority: Output<Int>? = null, val routeTypes: Output<List<String>>? = null, val sourceChildInstanceTypes: Output<List<String>>? = null, val sourceInstanceIds: Output<List<String>>? = null, val sourceInstanceIdsReverseMatch: Output<Boolean>? = null, val sourceRegionIds: Output<List<String>>? = null, val sourceRouteTableIds: Output<List<String>>? = null, val transitRouterRouteTableId: Output<String>? = null, val transmitDirection: Output<String>? = null) : ConvertibleToJava<RouteMapArgs>

This topic provides an overview of the route map function of Cloud Enterprise Networks (CENs). You can use the route map function to filter routes and modify route attributes. By doing so, you can manage the communication between networks attached to a CEN. For information about CEN Route Map and how to use it, see Manage CEN Route Map.

NOTE: Available in 1.82.0+

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cen.Instance;
import com.pulumi.alicloud.Provider;
import com.pulumi.alicloud.ProviderArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.cen.InstanceAttachment;
import com.pulumi.alicloud.cen.InstanceAttachmentArgs;
import com.pulumi.alicloud.cen.RouteMap;
import com.pulumi.alicloud.cen.RouteMapArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var defaultInstance = new Instance("defaultInstance");
        var vpc00Region = new Provider("vpc00Region", ProviderArgs.builder()
            .region("cn-hangzhou")
            .build());
        var vpc01Region = new Provider("vpc01Region", ProviderArgs.builder()
            .region("cn-shanghai")
            .build());
        var vpc00 = new Network("vpc00", NetworkArgs.builder()
            .cidrBlock("172.16.0.0/12")
            .build(), CustomResourceOptions.builder()
                .provider(alicloud.vpc00_region())
                .build());
        var vpc01 = new Network("vpc01", NetworkArgs.builder()
            .cidrBlock("172.16.0.0/12")
            .build(), CustomResourceOptions.builder()
                .provider(alicloud.vpc01_region())
                .build());
        var default00 = new InstanceAttachment("default00", InstanceAttachmentArgs.builder()
            .instanceId(defaultInstance.id())
            .childInstanceId(vpc00.id())
            .childInstanceType("VPC")
            .childInstanceRegionId("cn-hangzhou")
            .build());
        var default01 = new InstanceAttachment("default01", InstanceAttachmentArgs.builder()
            .instanceId(defaultInstance.id())
            .childInstanceId(vpc01.id())
            .childInstanceType("VPC")
            .childInstanceRegionId("cn-shanghai")
            .build());
        var defaultRouteMap = new RouteMap("defaultRouteMap", RouteMapArgs.builder()
            .cenRegionId("cn-hangzhou")
            .cenId(alicloud_cen_instance.cen().id())
            .description("test-desc")
            .priority("1")
            .transmitDirection("RegionIn")
            .mapResult("Permit")
            .nextPriority("1")
            .sourceRegionIds("cn-hangzhou")
            .sourceInstanceIds(vpc00.id())
            .sourceInstanceIdsReverseMatch("false")
            .destinationInstanceIds(vpc01.id())
            .destinationInstanceIdsReverseMatch("false")
            .sourceRouteTableIds(vpc00.routeTableId())
            .destinationRouteTableIds(vpc01.routeTableId())
            .sourceChildInstanceTypes("VPC")
            .destinationChildInstanceTypes("VPC")
            .destinationCidrBlocks(vpc01.cidrBlock())
            .cidrMatchMode("Include")
            .routeTypes("System")
            .matchAsns("65501")
            .asPathMatchMode("Include")
            .matchCommunitySets("65501:1")
            .communityMatchMode("Include")
            .communityOperateMode("Additive")
            .operateCommunitySets("65501:1")
            .preference("20")
            .prependAsPaths("65501")
            .build(), CustomResourceOptions.builder()
                .dependsOn(
                    default00,
                    default01)
                .build());
    }
}

Import

CEN RouteMap can be imported using the id, e.g.

$ pulumi import alicloud:cen/routeMap:RouteMap default <cen_id>:<route_map_id>.

Constructors

RouteMapArgs

fun RouteMapArgs(asPathMatchMode: Output<String>? = null, cenId: Output<String>? = null, cenRegionId: Output<String>? = null, cidrMatchMode: Output<String>? = null, communityMatchMode: Output<String>? = null, communityOperateMode: Output<String>? = null, description: Output<String>? = null, destinationChildInstanceTypes: Output<List<String>>? = null, destinationCidrBlocks: Output<List<String>>? = null, destinationInstanceIds: Output<List<String>>? = null, destinationInstanceIdsReverseMatch: Output<Boolean>? = null, destinationRouteTableIds: Output<List<String>>? = null, mapResult: Output<String>? = null, matchAsns: Output<List<String>>? = null, matchCommunitySets: Output<List<String>>? = null, nextPriority: Output<Int>? = null, operateCommunitySets: Output<List<String>>? = null, preference: Output<Int>? = null, prependAsPaths: Output<List<String>>? = null, priority: Output<Int>? = null, routeTypes: Output<List<String>>? = null, sourceChildInstanceTypes: Output<List<String>>? = null, sourceInstanceIds: Output<List<String>>? = null, sourceInstanceIdsReverseMatch: Output<Boolean>? = null, sourceRegionIds: Output<List<String>>? = null, sourceRouteTableIds: Output<List<String>>? = null, transitRouterRouteTableId: Output<String>? = null, transmitDirection: Output<String>? = null)

Functions

toJava

open override fun toJava(): RouteMapArgs

Properties

asPathMatchMode

val asPathMatchMode: Output<String>? = null

A match statement. It indicates the mode in which the AS path attribute is matched. Valid values: "Include", "Complete".

cenId

val cenId: Output<String>? = null

The ID of the CEN instance.

cenRegionId

val cenRegionId: Output<String>? = null

The ID of the region to which the CEN instance belongs.

cidrMatchMode

val cidrMatchMode: Output<String>? = null

A match statement. It indicates the mode in which the prefix attribute is matched. Valid values: "Include", "Complete".

communityMatchMode

val communityMatchMode: Output<String>? = null

A match statement. It indicates the mode in which the community attribute is matched. Valid values: "Include", "Complete".

communityOperateMode

val communityOperateMode: Output<String>? = null

An action statement. It indicates the mode in which the community attribute is operated. Valid values: "Additive", "Replace".

description

val description: Output<String>? = null

The description of the route map.

destinationChildInstanceTypes

val destinationChildInstanceTypes: Output<List<String>>? = null

A match statement that indicates the list of destination instance types. Valid values: "VPC", "VBR", "CCN", "VPN".

destinationCidrBlocks

val destinationCidrBlocks: Output<List<String>>? = null

A match statement that indicates the prefix list. The prefix is in the CIDR format. You can enter a maximum of 32 CIDR blocks.

destinationInstanceIds

val destinationInstanceIds: Output<List<String>>? = null

A match statement that indicates the list of IDs of the destination instances.

destinationInstanceIdsReverseMatch

val destinationInstanceIdsReverseMatch: Output<Boolean>? = null

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: "false", "true". Default to "false".

destinationRouteTableIds

val destinationRouteTableIds: Output<List<String>>? = null

A match statement that indicates the list of IDs of the destination route tables. You can enter a maximum of 32 route table IDs.

mapResult

val mapResult: Output<String>? = null

The action that is performed to a route if the route matches all the match conditions. Valid values: "Permit", "Deny".

matchAsns

val matchAsns: Output<List<String>>? = null

A match statement that indicates the AS path list. The AS path is a well-known mandatory attribute, which describes the numbers of the ASs that a BGP route passes through during transmission.

matchCommunitySets

val matchCommunitySets: Output<List<String>>? = null

A match statement that indicates the community set. The format of each community is nn:nn, which ranges from 1 to 65535. You can enter a maximum of 32 communities. Communities must comply with RFC 1997. Large communities (RFC 8092) are not supported.

nextPriority

val nextPriority: Output<Int>? = null

The priority of the next route map that is associated with the current route map. Value range: 1 to 100.

operateCommunitySets

val operateCommunitySets: Output<List<String>>? = null

An action statement that operates the community attribute. The format of each community is nn:nn, which ranges from 1 to 65535. You can enter a maximum of 32 communities. Communities must comply with RFC 1997. Large communities (RFC 8092) are not supported.

preference

val preference: Output<Int>? = null

An action statement that modifies the priority of the route. Value range: 1 to 100. The default priority of a route is 50. A lower value indicates a higher preference.

prependAsPaths

val prependAsPaths: Output<List<String>>? = null

An action statement that indicates an AS path is prepended when the regional gateway receives or advertises a route.

priority

val priority: Output<Int>? = null

The priority of the route map. Value range: 1 to 100. A lower value indicates a higher priority.

routeTypes

val routeTypes: Output<List<String>>? = null

A match statement that indicates the list of route types. Valid values: "System", "Custom", "BGP".

sourceChildInstanceTypes

val sourceChildInstanceTypes: Output<List<String>>? = null

A match statement that indicates the list of source instance types. Valid values: "VPC", "VBR", "CCN".

sourceInstanceIds

val sourceInstanceIds: Output<List<String>>? = null

A match statement that indicates the list of IDs of the source instances.

sourceInstanceIdsReverseMatch

val sourceInstanceIdsReverseMatch: Output<Boolean>? = null

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: "false", "true". Default to "false".

sourceRegionIds

val sourceRegionIds: Output<List<String>>? = null

A match statement that indicates the list of IDs of the source regions. You can enter a maximum of 32 region IDs.

sourceRouteTableIds

val sourceRouteTableIds: Output<List<String>>? = null

A match statement that indicates the list of IDs of the source route tables. You can enter a maximum of 32 route table IDs.

transitRouterRouteTableId

val transitRouterRouteTableId: Output<String>? = null

The routing table ID of the forwarding router. If you do not enter the routing table ID, the routing policy is automatically associated with the default routing table of the forwarding router.

transmitDirection

val transmitDirection: Output<String>? = null

The direction in which the route map is applied. Valid values: "RegionIn", "RegionOut".