1. Docs
  2. Reference
  3. API
  4. AliCloud
  5. cen
  6. RouteMap

RouteMap

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

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var defaultInstance = new AliCloud.Cen.Instance("defaultInstance", new AliCloud.Cen.InstanceArgs
        {
        });
        var vpc00Region = new AliCloud.Provider("vpc00Region", new AliCloud.ProviderArgs
        {
            Region = "cn-hangzhou",
        });
        var vpc01Region = new AliCloud.Provider("vpc01Region", new AliCloud.ProviderArgs
        {
            Region = "cn-shanghai",
        });
        var vpc00 = new AliCloud.Vpc.Network("vpc00", new AliCloud.Vpc.NetworkArgs
        {
            CidrBlock = "172.16.0.0/12",
        });
        var vpc01 = new AliCloud.Vpc.Network("vpc01", new AliCloud.Vpc.NetworkArgs
        {
            CidrBlock = "172.16.0.0/12",
        });
        var default00 = new AliCloud.Cen.InstanceAttachment("default00", new AliCloud.Cen.InstanceAttachmentArgs
        {
            ChildInstanceId = vpc00.Id,
            ChildInstanceRegionId = "cn-hangzhou",
            InstanceId = defaultInstance.Id,
        });
        var default01 = new AliCloud.Cen.InstanceAttachment("default01", new AliCloud.Cen.InstanceAttachmentArgs
        {
            ChildInstanceId = vpc01.Id,
            ChildInstanceRegionId = "cn-shanghai",
            InstanceId = defaultInstance.Id,
        });
        var defaultRouteMap = new AliCloud.Cen.RouteMap("defaultRouteMap", new AliCloud.Cen.RouteMapArgs
        {
            AsPathMatchMode = "Include",
            CenId = alicloud_cen_instance.Cen.Id,
            CenRegionId = "cn-hangzhou",
            CidrMatchMode = "Include",
            CommunityMatchMode = "Include",
            CommunityOperateMode = "Additive",
            Description = "test-desc",
            DestinationChildInstanceTypes = 
            {
                "VPC",
            },
            DestinationCidrBlocks = 
            {
                vpc01.CidrBlock,
            },
            DestinationInstanceIds = 
            {
                vpc01.Id,
            },
            DestinationInstanceIdsReverseMatch = false,
            DestinationRouteTableIds = 
            {
                vpc01.RouteTableId,
            },
            MapResult = "Permit",
            MatchAsns = 
            {
                "65501",
            },
            MatchCommunitySets = 
            {
                "65501:1",
            },
            NextPriority = 1,
            OperateCommunitySets = 
            {
                "65501:1",
            },
            Preference = 20,
            PrependAsPaths = 
            {
                "65501",
            },
            Priority = 1,
            RouteTypes = 
            {
                "System",
            },
            SourceChildInstanceTypes = 
            {
                "VPC",
            },
            SourceInstanceIds = 
            {
                vpc00.Id,
            },
            SourceInstanceIdsReverseMatch = false,
            SourceRegionIds = 
            {
                "cn-hangzhou",
            },
            SourceRouteTableIds = 
            {
                vpc00.RouteTableId,
            },
            TransmitDirection = "RegionIn",
        });
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud
import pulumi_pulumi as pulumi

default_instance = alicloud.cen.Instance("defaultInstance")
vpc00_region = pulumi.providers.Alicloud("vpc00Region", region="cn-hangzhou")
vpc01_region = pulumi.providers.Alicloud("vpc01Region", region="cn-shanghai")
vpc00 = alicloud.vpc.Network("vpc00", cidr_block="172.16.0.0/12")
vpc01 = alicloud.vpc.Network("vpc01", cidr_block="172.16.0.0/12")
default00 = alicloud.cen.InstanceAttachment("default00",
    child_instance_id=vpc00.id,
    child_instance_region_id="cn-hangzhou",
    instance_id=default_instance.id)
default01 = alicloud.cen.InstanceAttachment("default01",
    child_instance_id=vpc01.id,
    child_instance_region_id="cn-shanghai",
    instance_id=default_instance.id)
default_route_map = alicloud.cen.RouteMap("defaultRouteMap",
    as_path_match_mode="Include",
    cen_id=alicloud_cen_instance["cen"]["id"],
    cen_region_id="cn-hangzhou",
    cidr_match_mode="Include",
    community_match_mode="Include",
    community_operate_mode="Additive",
    description="test-desc",
    destination_child_instance_types=["VPC"],
    destination_cidr_blocks=[vpc01.cidr_block],
    destination_instance_ids=[vpc01.id],
    destination_instance_ids_reverse_match="false",
    destination_route_table_ids=[vpc01.route_table_id],
    map_result="Permit",
    match_asns=["65501"],
    match_community_sets=["65501:1"],
    next_priority="1",
    operate_community_sets=["65501:1"],
    preference="20",
    prepend_as_paths=["65501"],
    priority="1",
    route_types=["System"],
    source_child_instance_types=["VPC"],
    source_instance_ids=[vpc00.id],
    source_instance_ids_reverse_match="false",
    source_region_ids=["cn-hangzhou"],
    source_route_table_ids=[vpc00.route_table_id],
    transmit_direction="RegionIn")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultInstance = new alicloud.cen.Instance("default", {});
const vpc00Region = new alicloud.Provider("vpc00_region", {
    region: "cn-hangzhou",
});
const vpc01Region = new alicloud.Provider("vpc01_region", {
    region: "cn-shanghai",
});
const vpc00 = new alicloud.vpc.Network("vpc00", {
    cidrBlock: "172.16.0.0/12",
}, { provider: vpc00Region });
const vpc01 = new alicloud.vpc.Network("vpc01", {
    cidrBlock: "172.16.0.0/12",
}, { provider: vpc01Region });
const default00 = new alicloud.cen.InstanceAttachment("default00", {
    childInstanceId: vpc00.id,
    childInstanceRegionId: "cn-hangzhou",
    instanceId: defaultInstance.id,
});
const default01 = new alicloud.cen.InstanceAttachment("default01", {
    childInstanceId: vpc01.id,
    childInstanceRegionId: "cn-shanghai",
    instanceId: defaultInstance.id,
});
const defaultRouteMap = new alicloud.cen.RouteMap("default", {
    asPathMatchMode: "Include",
    cenId: alicloud_cen_instance_cen.id,
    cenRegionId: "cn-hangzhou",
    cidrMatchMode: "Include",
    communityMatchMode: "Include",
    communityOperateMode: "Additive",
    description: "test-desc",
    destinationChildInstanceTypes: ["VPC"],
    destinationCidrBlocks: [vpc01.cidrBlock],
    destinationInstanceIds: [vpc01.id],
    destinationInstanceIdsReverseMatch: false,
    destinationRouteTableIds: [vpc01.routeTableId],
    mapResult: "Permit",
    matchAsns: ["65501"],
    matchCommunitySets: ["65501:1"],
    nextPriority: 1,
    operateCommunitySets: ["65501:1"],
    preference: 20,
    prependAsPaths: ["65501"],
    priority: 1,
    routeTypes: ["System"],
    sourceChildInstanceTypes: ["VPC"],
    sourceInstanceIds: [vpc00.id],
    sourceInstanceIdsReverseMatch: false,
    sourceRegionIds: ["cn-hangzhou"],
    sourceRouteTableIds: [vpc00.routeTableId],
    transmitDirection: "RegionIn",
}, { dependsOn: [default00, default01] });

Create a RouteMap Resource

new RouteMap(name: string, args: RouteMapArgs, opts?: CustomResourceOptions);
def RouteMap(resource_name, opts=None, as_path_match_mode=None, cen_id=None, cen_region_id=None, cidr_match_mode=None, community_match_mode=None, community_operate_mode=None, description=None, destination_child_instance_types=None, destination_cidr_blocks=None, destination_instance_ids=None, destination_instance_ids_reverse_match=None, destination_route_table_ids=None, map_result=None, match_asns=None, match_community_sets=None, next_priority=None, operate_community_sets=None, preference=None, prepend_as_paths=None, priority=None, route_types=None, source_child_instance_types=None, source_instance_ids=None, source_instance_ids_reverse_match=None, source_region_ids=None, source_route_table_ids=None, transmit_direction=None, __props__=None);
func NewRouteMap(ctx *Context, name string, args RouteMapArgs, opts ...ResourceOption) (*RouteMap, error)
public RouteMap(string name, RouteMapArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RouteMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RouteMapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RouteMapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RouteMap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RouteMap resource accepts the following input properties:

CenId string

The ID of the CEN instance.

CenRegionId string

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

MapResult string

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

Priority int

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

TransmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

AsPathMatchMode string

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

CidrMatchMode string

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

CommunityMatchMode string

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

CommunityOperateMode string

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

Description string

The description of the route map.

DestinationChildInstanceTypes List<string>

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

DestinationCidrBlocks 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 List<string>

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

DestinationInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

DestinationRouteTableIds 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.

MatchAsns 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 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 int

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

OperateCommunitySets 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 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 List<string>

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

RouteTypes List<string>

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

SourceChildInstanceTypes List<string>

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

SourceInstanceIds List<string>

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

SourceInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

SourceRegionIds 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 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.

CenId string

The ID of the CEN instance.

CenRegionId string

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

MapResult string

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

Priority int

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

TransmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

AsPathMatchMode string

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

CidrMatchMode string

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

CommunityMatchMode string

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

CommunityOperateMode string

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

Description string

The description of the route map.

DestinationChildInstanceTypes []string

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

DestinationCidrBlocks []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 []string

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

DestinationInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

DestinationRouteTableIds []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.

MatchAsns []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 []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 int

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

OperateCommunitySets []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 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 []string

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

RouteTypes []string

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

SourceChildInstanceTypes []string

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

SourceInstanceIds []string

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

SourceInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

SourceRegionIds []string

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

SourceRouteTableIds []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.

cenId string

The ID of the CEN instance.

cenRegionId string

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

mapResult string

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

priority number

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

transmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

asPathMatchMode string

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

cidrMatchMode string

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

communityMatchMode string

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

communityOperateMode string

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

description string

The description of the route map.

destinationChildInstanceTypes string[]

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

destinationCidrBlocks 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 string[]

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

destinationInstanceIdsReverseMatch boolean

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

destinationRouteTableIds 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.

matchAsns 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 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 number

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

operateCommunitySets 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 number

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 string[]

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

routeTypes string[]

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

sourceChildInstanceTypes string[]

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

sourceInstanceIds string[]

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

sourceInstanceIdsReverseMatch boolean

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

sourceRegionIds string[]

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

sourceRouteTableIds 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.

cen_id str

The ID of the CEN instance.

cen_region_id str

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

map_result str

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

priority float

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

transmit_direction str

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

as_path_match_mode str

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

cidr_match_mode str

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

community_match_mode str

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

community_operate_mode str

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

description str

The description of the route map.

destination_child_instance_types List[str]

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

destination_cidr_blocks List[str]

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

destination_instance_ids List[str]

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

destination_instance_ids_reverse_match bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

destination_route_table_ids List[str]

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

match_asns List[str]

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.

match_community_sets List[str]

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.

next_priority float

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

operate_community_sets List[str]

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 float

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.

prepend_as_paths List[str]

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

route_types List[str]

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

source_child_instance_types List[str]

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

source_instance_ids List[str]

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

source_instance_ids_reverse_match bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

source_region_ids List[str]

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

source_route_table_ids List[str]

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

Outputs

All input properties are implicitly available as output properties. Additionally, the RouteMap resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
RouteMapId string
Status string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

Id string
The provider-assigned unique ID for this managed resource.
RouteMapId string
Status string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

id string
The provider-assigned unique ID for this managed resource.
routeMapId string
status string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

id str
The provider-assigned unique ID for this managed resource.
route_map_id str
status str

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

Look up an Existing RouteMap Resource

Get an existing RouteMap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteMapState, opts?: CustomResourceOptions): RouteMap
static get(resource_name, id, opts=None, as_path_match_mode=None, cen_id=None, cen_region_id=None, cidr_match_mode=None, community_match_mode=None, community_operate_mode=None, description=None, destination_child_instance_types=None, destination_cidr_blocks=None, destination_instance_ids=None, destination_instance_ids_reverse_match=None, destination_route_table_ids=None, map_result=None, match_asns=None, match_community_sets=None, next_priority=None, operate_community_sets=None, preference=None, prepend_as_paths=None, priority=None, route_map_id=None, route_types=None, source_child_instance_types=None, source_instance_ids=None, source_instance_ids_reverse_match=None, source_region_ids=None, source_route_table_ids=None, status=None, transmit_direction=None, __props__=None);
func GetRouteMap(ctx *Context, name string, id IDInput, state *RouteMapState, opts ...ResourceOption) (*RouteMap, error)
public static RouteMap Get(string name, Input<string> id, RouteMapState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AsPathMatchMode string

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

CenId string

The ID of the CEN instance.

CenRegionId string

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

CidrMatchMode string

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

CommunityMatchMode string

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

CommunityOperateMode string

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

Description string

The description of the route map.

DestinationChildInstanceTypes List<string>

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

DestinationCidrBlocks 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 List<string>

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

DestinationInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

DestinationRouteTableIds 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.

MapResult string

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

MatchAsns 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 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 int

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

OperateCommunitySets 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 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 List<string>

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

Priority int

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

RouteMapId string
RouteTypes List<string>

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

SourceChildInstanceTypes List<string>

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

SourceInstanceIds List<string>

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

SourceInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

SourceRegionIds 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 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 string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

TransmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

AsPathMatchMode string

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

CenId string

The ID of the CEN instance.

CenRegionId string

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

CidrMatchMode string

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

CommunityMatchMode string

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

CommunityOperateMode string

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

Description string

The description of the route map.

DestinationChildInstanceTypes []string

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

DestinationCidrBlocks []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 []string

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

DestinationInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

DestinationRouteTableIds []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.

MapResult string

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

MatchAsns []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 []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 int

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

OperateCommunitySets []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 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 []string

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

Priority int

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

RouteMapId string
RouteTypes []string

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

SourceChildInstanceTypes []string

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

SourceInstanceIds []string

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

SourceInstanceIdsReverseMatch bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

SourceRegionIds []string

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

SourceRouteTableIds []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 string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

TransmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

asPathMatchMode string

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

cenId string

The ID of the CEN instance.

cenRegionId string

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

cidrMatchMode string

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

communityMatchMode string

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

communityOperateMode string

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

description string

The description of the route map.

destinationChildInstanceTypes string[]

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

destinationCidrBlocks 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 string[]

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

destinationInstanceIdsReverseMatch boolean

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

destinationRouteTableIds 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.

mapResult string

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

matchAsns 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 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 number

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

operateCommunitySets 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 number

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 string[]

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

priority number

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

routeMapId string
routeTypes string[]

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

sourceChildInstanceTypes string[]

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

sourceInstanceIds string[]

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

sourceInstanceIdsReverseMatch boolean

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

sourceRegionIds string[]

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

sourceRouteTableIds 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 string

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

transmitDirection string

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

as_path_match_mode str

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

cen_id str

The ID of the CEN instance.

cen_region_id str

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

cidr_match_mode str

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

community_match_mode str

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

community_operate_mode str

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

description str

The description of the route map.

destination_child_instance_types List[str]

A match statement that indicates the list of destination instance types. Valid values: [“VPC”, “VBR”, “CCN”].

destination_cidr_blocks List[str]

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

destination_instance_ids List[str]

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

destination_instance_ids_reverse_match bool

Indicates whether to enable the reverse match method for the DestinationInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

destination_route_table_ids List[str]

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

map_result str

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

match_asns List[str]

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.

match_community_sets List[str]

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.

next_priority float

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

operate_community_sets List[str]

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 float

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.

prepend_as_paths List[str]

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

priority float

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

route_map_id str
route_types List[str]

A match statement that indicates the list of route types. Valid values: [“System”, “Custom”, “BGP”].

source_child_instance_types List[str]

A match statement that indicates the list of source instance types. Valid values: [“VPC”, “VBR”, “CCN”].

source_instance_ids List[str]

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

source_instance_ids_reverse_match bool

Indicates whether to enable the reverse match method for the SourceInstanceIds match condition. Valid values: [“false”, “true”]. Default to “false”.

source_region_ids List[str]

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

source_route_table_ids List[str]

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 str

(Computed) The status of route map. Valid values: [“Creating”, “Active”, “Deleting”].

transmit_direction str

The direction in which the route map is applied. Valid values: [“RegionIn”, “RegionOut”].

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.