Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. vpn
  6. VpnGatewayRoute
Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vpn.VpnGatewayRoute

bytepluscc logo
Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Add a route entry to the VPN gateway.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const vpnGatewayRouteDemo = new bytepluscc.vpn.VpnGatewayRoute("VpnGatewayRouteDemo", {
    destinationCidrBlock: "192.168.0.0/25",
    nextHopId: "vgc-****",
    vpnGatewayId: "vgw-****",
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

vpn_gateway_route_demo = bytepluscc.vpn.VpnGatewayRoute("VpnGatewayRouteDemo",
    destination_cidr_block="192.168.0.0/25",
    next_hop_id="vgc-****",
    vpn_gateway_id="vgw-****")

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/vpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.NewVpnGatewayRoute(ctx, "VpnGatewayRouteDemo", &vpn.VpnGatewayRouteArgs{
			DestinationCidrBlock: pulumi.String("192.168.0.0/25"),
			NextHopId:            pulumi.String("vgc-****"),
			VpnGatewayId:         pulumi.String("vgw-****"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var vpnGatewayRouteDemo = new Bytepluscc.Vpn.VpnGatewayRoute("VpnGatewayRouteDemo", new()
    {
        DestinationCidrBlock = "192.168.0.0/25",
        NextHopId = "vgc-****",
        VpnGatewayId = "vgw-****",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.vpn.VpnGatewayRoute;
import com.byteplus.bytepluscc.vpn.VpnGatewayRouteArgs;
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 vpnGatewayRouteDemo = new VpnGatewayRoute("vpnGatewayRouteDemo", VpnGatewayRouteArgs.builder()
            .destinationCidrBlock("192.168.0.0/25")
            .nextHopId("vgc-****")
            .vpnGatewayId("vgw-****")
            .build());

    }
}

    resources:
  vpnGatewayRouteDemo:
    type: bytepluscc:vpn:VpnGatewayRoute
    name: VpnGatewayRouteDemo
    properties:
      destinationCidrBlock: 192.168.0.0/25
      nextHopId: vgc-****
      vpnGatewayId: vgw-****

    Example coming soon!

    Create VpnGatewayRoute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpnGatewayRoute(name: string, args: VpnGatewayRouteArgs, opts?: CustomResourceOptions);
    @overload
def VpnGatewayRoute(resource_name: str,
                    args: VpnGatewayRouteArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def VpnGatewayRoute(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    destination_cidr_block: Optional[str] = None,
                    next_hop_id: Optional[str] = None,
                    vpn_gateway_id: Optional[str] = None)
    func NewVpnGatewayRoute(ctx *Context, name string, args VpnGatewayRouteArgs, opts ...ResourceOption) (*VpnGatewayRoute, error)
    public VpnGatewayRoute(string name, VpnGatewayRouteArgs args, CustomResourceOptions? opts = null)
    public VpnGatewayRoute(String name, VpnGatewayRouteArgs args)
public VpnGatewayRoute(String name, VpnGatewayRouteArgs args, CustomResourceOptions options)

    type: bytepluscc:vpn:VpnGatewayRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "bytepluscc_vpn_vpngatewayroute" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args VpnGatewayRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpnGatewayRouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpnGatewayRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnGatewayRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnGatewayRouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vpnGatewayRouteResource = new Bytepluscc.Vpn.VpnGatewayRoute("vpnGatewayRouteResource", new()
{
    DestinationCidrBlock = "string",
    NextHopId = "string",
    VpnGatewayId = "string",
});

    example, err := vpn.NewVpnGatewayRoute(ctx, "vpnGatewayRouteResource", &vpn.VpnGatewayRouteArgs{
	DestinationCidrBlock: pulumi.String("string"),
	NextHopId:            pulumi.String("string"),
	VpnGatewayId:         pulumi.String("string"),
})

    resource "bytepluscc_vpn_vpngatewayroute" "vpnGatewayRouteResource" {
  destination_cidr_block = "string"
  next_hop_id            = "string"
  vpn_gateway_id         = "string"
}

    var vpnGatewayRouteResource = new VpnGatewayRoute("vpnGatewayRouteResource", VpnGatewayRouteArgs.builder()
    .destinationCidrBlock("string")
    .nextHopId("string")
    .vpnGatewayId("string")
    .build());

    vpn_gateway_route_resource = bytepluscc.vpn.VpnGatewayRoute("vpnGatewayRouteResource",
    destination_cidr_block="string",
    next_hop_id="string",
    vpn_gateway_id="string")

    const vpnGatewayRouteResource = new bytepluscc.vpn.VpnGatewayRoute("vpnGatewayRouteResource", {
    destinationCidrBlock: "string",
    nextHopId: "string",
    vpnGatewayId: "string",
});

    type: bytepluscc:vpn:VpnGatewayRoute
properties:
    destinationCidrBlock: string
    nextHopId: string
    vpnGatewayId: string

    VpnGatewayRoute Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpnGatewayRoute resource accepts the following input properties:

    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    NextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    VpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    NextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    VpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    destination_cidr_block string
    Destination network segment of the VPN gateway route entry.
    next_hop_id string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    vpn_gateway_id string
    ID of the VPN gateway for the route entry to be added.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    nextHopId String
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    vpnGatewayId String
    ID of the VPN gateway for the route entry to be added.
    destinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    nextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    vpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    destination_cidr_block str
    Destination network segment of the VPN gateway route entry.
    next_hop_id str
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    vpn_gateway_id str
    ID of the VPN gateway for the route entry to be added.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    nextHopId String
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    vpnGatewayId String
    ID of the VPN gateway for the route entry to be added.

    Outputs

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

    AsPaths List<Byteplus.VpnGatewayRouteAsPath>
    CreationTime string
    Time when the VPN gateway route entry was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    RouteType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    Status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    UpdateTime string
    Time when the VPN gateway route entry was modified.
    VpnGatewayRouteId string
    ID of the VPN gateway route entry.
    AsPaths []VpnGatewayRouteAsPath
    CreationTime string
    Time when the VPN gateway route entry was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    NextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    RouteType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    Status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    UpdateTime string
    Time when the VPN gateway route entry was modified.
    VpnGatewayRouteId string
    ID of the VPN gateway route entry.
    as_paths list(object)
    creation_time string
    Time when the VPN gateway route entry was created.
    id string
    The provider-assigned unique ID for this managed resource.
    next_tunnel_id string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    route_type string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    update_time string
    Time when the VPN gateway route entry was modified.
    vpn_gateway_route_id string
    ID of the VPN gateway route entry.
    asPaths List<VpnGatewayRouteAsPath>
    creationTime String
    Time when the VPN gateway route entry was created.
    id String
    The provider-assigned unique ID for this managed resource.
    nextTunnelId String
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType String
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status String
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime String
    Time when the VPN gateway route entry was modified.
    vpnGatewayRouteId String
    ID of the VPN gateway route entry.
    asPaths VpnGatewayRouteAsPath[]
    creationTime string
    Time when the VPN gateway route entry was created.
    id string
    The provider-assigned unique ID for this managed resource.
    nextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime string
    Time when the VPN gateway route entry was modified.
    vpnGatewayRouteId string
    ID of the VPN gateway route entry.
    as_paths Sequence[VpnGatewayRouteAsPath]
    creation_time str
    Time when the VPN gateway route entry was created.
    id str
    The provider-assigned unique ID for this managed resource.
    next_tunnel_id str
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    route_type str
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status str
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    update_time str
    Time when the VPN gateway route entry was modified.
    vpn_gateway_route_id str
    ID of the VPN gateway route entry.
    asPaths List<Property Map>
    creationTime String
    Time when the VPN gateway route entry was created.
    id String
    The provider-assigned unique ID for this managed resource.
    nextTunnelId String
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType String
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status String
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime String
    Time when the VPN gateway route entry was modified.
    vpnGatewayRouteId String
    ID of the VPN gateway route entry.

    Look up Existing VpnGatewayRoute Resource

    Get an existing VpnGatewayRoute 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?: VpnGatewayRouteState, opts?: CustomResourceOptions): VpnGatewayRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        as_paths: Optional[Sequence[VpnGatewayRouteAsPathArgs]] = None,
        creation_time: Optional[str] = None,
        destination_cidr_block: Optional[str] = None,
        next_hop_id: Optional[str] = None,
        next_tunnel_id: Optional[str] = None,
        route_type: Optional[str] = None,
        status: Optional[str] = None,
        update_time: Optional[str] = None,
        vpn_gateway_id: Optional[str] = None,
        vpn_gateway_route_id: Optional[str] = None) -> VpnGatewayRoute
    func GetVpnGatewayRoute(ctx *Context, name string, id IDInput, state *VpnGatewayRouteState, opts ...ResourceOption) (*VpnGatewayRoute, error)
    public static VpnGatewayRoute Get(string name, Input<string> id, VpnGatewayRouteState? state, CustomResourceOptions? opts = null)
    public static VpnGatewayRoute get(String name, Output<String> id, VpnGatewayRouteState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:vpn:VpnGatewayRoute    get:      id: ${id}
    import {
  to = bytepluscc_vpn_vpngatewayroute.example
  id = "${id}"
}
    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.
    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:
    AsPaths List<Byteplus.VpnGatewayRouteAsPath>
    CreationTime string
    Time when the VPN gateway route entry was created.
    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    NextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    NextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    RouteType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    Status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    UpdateTime string
    Time when the VPN gateway route entry was modified.
    VpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    VpnGatewayRouteId string
    ID of the VPN gateway route entry.
    AsPaths []VpnGatewayRouteAsPathArgs
    CreationTime string
    Time when the VPN gateway route entry was created.
    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    NextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    NextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    RouteType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    Status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    UpdateTime string
    Time when the VPN gateway route entry was modified.
    VpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    VpnGatewayRouteId string
    ID of the VPN gateway route entry.
    as_paths list(object)
    creation_time string
    Time when the VPN gateway route entry was created.
    destination_cidr_block string
    Destination network segment of the VPN gateway route entry.
    next_hop_id string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    next_tunnel_id string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    route_type string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    update_time string
    Time when the VPN gateway route entry was modified.
    vpn_gateway_id string
    ID of the VPN gateway for the route entry to be added.
    vpn_gateway_route_id string
    ID of the VPN gateway route entry.
    asPaths List<VpnGatewayRouteAsPath>
    creationTime String
    Time when the VPN gateway route entry was created.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    nextHopId String
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    nextTunnelId String
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType String
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status String
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime String
    Time when the VPN gateway route entry was modified.
    vpnGatewayId String
    ID of the VPN gateway for the route entry to be added.
    vpnGatewayRouteId String
    ID of the VPN gateway route entry.
    asPaths VpnGatewayRouteAsPath[]
    creationTime string
    Time when the VPN gateway route entry was created.
    destinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    nextHopId string
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    nextTunnelId string
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType string
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status string
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime string
    Time when the VPN gateway route entry was modified.
    vpnGatewayId string
    ID of the VPN gateway for the route entry to be added.
    vpnGatewayRouteId string
    ID of the VPN gateway route entry.
    as_paths Sequence[VpnGatewayRouteAsPathArgs]
    creation_time str
    Time when the VPN gateway route entry was created.
    destination_cidr_block str
    Destination network segment of the VPN gateway route entry.
    next_hop_id str
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    next_tunnel_id str
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    route_type str
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status str
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    update_time str
    Time when the VPN gateway route entry was modified.
    vpn_gateway_id str
    ID of the VPN gateway for the route entry to be added.
    vpn_gateway_route_id str
    ID of the VPN gateway route entry.
    asPaths List<Property Map>
    creationTime String
    Time when the VPN gateway route entry was created.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    nextHopId String
    ID of the IPsec connection for the route's next hop. You can call DescribeVpnConnections to query the IPsec connection ID.
    nextTunnelId String
    Next hop tunnel ID. This parameter is returned only for VPN gateways in dual-tunnel mode.
    routeType String
    Route type. Static: static route; BGP: BGP route; Cloud: VPC route in the cloud. Note: Route types synchronized from transit routers (TR) are not currently supported for display.
    status String
    Status of the VPN gateway route entry. Creating: being created; Deleting: being deleted; Pending: being configured; Available: preferred route in effect; Conflicted: not preferred or not in effect. Note: When route prefixes are the same, the route priority is Cloud > Static route > BGP route. Therefore, there may be multiple routes with the same prefix, some with status Available and others with status Conflicted.
    updateTime String
    Time when the VPN gateway route entry was modified.
    vpnGatewayId String
    ID of the VPN gateway for the route entry to be added.
    vpnGatewayRouteId String
    ID of the VPN gateway route entry.

    Supporting Types

    VpnGatewayRouteAsPath, VpnGatewayRouteAsPathArgs

    Numbers List<int>
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    Type string
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    Numbers []int
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    Type string
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    numbers list(number)
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    type string
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    numbers List<Integer>
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    type String
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    numbers number[]
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    type string
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    numbers Sequence[int]
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    type str
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.
    numbers List<Number>
    AS path sequence. If the AS path type is Sequence, the returned data is the original ASN sequence, such as [65533]. If the AS path type is Set, it indicates that the AS path has been aggregated, and the returned data is the aggregated ASN sequence, such as [4,5].
    type String
    AS path type. Sequence: normal ordered sequence; Set: aggregated sequence.

    Import

    $ pulumi import bytepluscc:vpn/vpnGatewayRoute:VpnGatewayRoute example "vpn_gateway_route_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.31
    published on Monday, Jun 1, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial