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

RouteMap

class RouteMap : KotlinCustomResource

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 since v1.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.Provider;
import com.pulumi.alicloud.ProviderArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.cen.Instance;
import com.pulumi.alicloud.cen.InstanceArgs;
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) {
        final var config = ctx.config();
        final var sourceRegion = config.get("sourceRegion").orElse("cn-hangzhou");
        final var destinationRegion = config.get("destinationRegion").orElse("cn-shanghai");
        var hz = new Provider("hz", ProviderArgs.builder()
            .region(sourceRegion)
            .build());
        var sh = new Provider("sh", ProviderArgs.builder()
            .region(destinationRegion)
            .build());
        var exampleHzNetwork = new Network("exampleHzNetwork", NetworkArgs.builder()
            .vpcName("tf_example")
            .cidrBlock("192.168.0.0/16")
            .build(), CustomResourceOptions.builder()
                .provider(alicloud.hz())
                .build());
        var exampleShNetwork = new Network("exampleShNetwork", NetworkArgs.builder()
            .vpcName("tf_example")
            .cidrBlock("172.16.0.0/12")
            .build(), CustomResourceOptions.builder()
                .provider(alicloud.sh())
                .build());
        var example = new Instance("example", InstanceArgs.builder()
            .cenInstanceName("tf_example")
            .description("an example for cen")
            .build());
        var exampleHzInstanceAttachment = new InstanceAttachment("exampleHzInstanceAttachment", InstanceAttachmentArgs.builder()
            .instanceId(example.id())
            .childInstanceId(exampleHzNetwork.id())
            .childInstanceType("VPC")
            .childInstanceRegionId(sourceRegion)
            .build());
        var exampleShInstanceAttachment = new InstanceAttachment("exampleShInstanceAttachment", InstanceAttachmentArgs.builder()
            .instanceId(example.id())
            .childInstanceId(exampleShNetwork.id())
            .childInstanceType("VPC")
            .childInstanceRegionId(destinationRegion)
            .build());
        var default_ = new RouteMap("default", RouteMapArgs.builder()
            .cenRegionId(sourceRegion)
            .cenId(example.id())
            .description("tf_example")
            .priority("1")
            .transmitDirection("RegionIn")
            .mapResult("Permit")
            .nextPriority("1")
            .sourceRegionIds(sourceRegion)
            .sourceInstanceIds(exampleHzInstanceAttachment.childInstanceId())
            .sourceInstanceIdsReverseMatch("false")
            .destinationInstanceIds(exampleShInstanceAttachment.childInstanceId())
            .destinationInstanceIdsReverseMatch("false")
            .sourceRouteTableIds(exampleHzNetwork.routeTableId())
            .destinationRouteTableIds(exampleShNetwork.routeTableId())
            .sourceChildInstanceTypes("VPC")
            .destinationChildInstanceTypes("VPC")
            .destinationCidrBlocks(exampleShNetwork.cidrBlock())
            .cidrMatchMode("Include")
            .routeTypes("System")
            .matchAsns("65501")
            .asPathMatchMode("Include")
            .matchCommunitySets("65501:1")
            .communityMatchMode("Include")
            .communityOperateMode("Additive")
            .operateCommunitySets("65501:1")
            .preference("20")
            .prependAsPaths("65501")
            .build());
    }
}

Import

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

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

Properties

asPathMatchMode

val asPathMatchMode: Output<String>?

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

cenId

val cenId: Output<String>

The ID of the CEN instance.

cenRegionId

val cenRegionId: Output<String>

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

cidrMatchMode

val cidrMatchMode: Output<String>?

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

communityMatchMode

val communityMatchMode: Output<String>?

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

communityOperateMode

val communityOperateMode: Output<String>?

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

description

val description: Output<String>?

The description of the route map.

destinationChildInstanceTypes

val destinationChildInstanceTypes: Output<List<String>>?

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

destinationCidrBlocks

val destinationCidrBlocks: Output<List<String>>?

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>>?

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

destinationInstanceIdsReverseMatch

val destinationInstanceIdsReverseMatch: Output<Boolean>?

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>>?

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

val id: Output<String>

mapResult

val mapResult: Output<String>

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>>?

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>>?

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>?

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>>?

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>?

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>>?

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

priority

val priority: Output<Int>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

routeMapId

val routeMapId: Output<String>

ID of the RouteMap. It is available in 1.161.0+.

routeTypes

val routeTypes: Output<List<String>>?

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

sourceChildInstanceTypes

val sourceChildInstanceTypes: Output<List<String>>?

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

sourceInstanceIds

val sourceInstanceIds: Output<List<String>>?

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

sourceInstanceIdsReverseMatch

val sourceInstanceIdsReverseMatch: Output<Boolean>?

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>>?

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>>?

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

status

val status: Output<String>

(Computed) The status of route map. Valid values: "Creating", "Active", "Deleting".

transitRouterRouteTableId

val transitRouterRouteTableId: Output<String>

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>

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

urn

val urn: Output<String>