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

bytepluscc.vpn.getVpnGatewayRoute

bytepluscc logo
Viewing docs for bytepluscc v0.0.30
published on Monday, May 25, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::VPN::VpnGatewayRoute

    Using getVpnGatewayRoute

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVpnGatewayRoute(args: GetVpnGatewayRouteArgs, opts?: InvokeOptions): Promise<GetVpnGatewayRouteResult>
function getVpnGatewayRouteOutput(args: GetVpnGatewayRouteOutputArgs, opts?: InvokeOptions): Output<GetVpnGatewayRouteResult>
    def get_vpn_gateway_route(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetVpnGatewayRouteResult
def get_vpn_gateway_route_output(id: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetVpnGatewayRouteResult]
    func LookupVpnGatewayRoute(ctx *Context, args *LookupVpnGatewayRouteArgs, opts ...InvokeOption) (*LookupVpnGatewayRouteResult, error)
func LookupVpnGatewayRouteOutput(ctx *Context, args *LookupVpnGatewayRouteOutputArgs, opts ...InvokeOption) LookupVpnGatewayRouteResultOutput

    > Note: This function is named LookupVpnGatewayRoute in the Go SDK.

    public static class GetVpnGatewayRoute 
{
    public static Task<GetVpnGatewayRouteResult> InvokeAsync(GetVpnGatewayRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnGatewayRouteResult> Invoke(GetVpnGatewayRouteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnGatewayRouteResult> getVpnGatewayRoute(GetVpnGatewayRouteArgs args, InvokeOptions options)
public static Output<GetVpnGatewayRouteResult> getVpnGatewayRoute(GetVpnGatewayRouteArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:vpn/getVpnGatewayRoute:getVpnGatewayRoute
  arguments:
    # arguments dictionary
    data "bytepluscc_vpn_getvpngatewayroute" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getVpnGatewayRoute Result

    The following output properties are available:

    AsPaths List<Byteplus.GetVpnGatewayRouteAsPath>
    AS path information traversed by the BGP route entry.
    CreationTime string
    Time when the VPN gateway route entry was created.
    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    Id string
    Uniquely identifies the resource.
    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 []GetVpnGatewayRouteAsPath
    AS path information traversed by the BGP route entry.
    CreationTime string
    Time when the VPN gateway route entry was created.
    DestinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    Id string
    Uniquely identifies the resource.
    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)
    AS path information traversed by the BGP route entry.
    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.
    id string
    Uniquely identifies the resource.
    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<GetVpnGatewayRouteAsPath>
    AS path information traversed by the BGP route entry.
    creationTime String
    Time when the VPN gateway route entry was created.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    id String
    Uniquely identifies the resource.
    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 GetVpnGatewayRouteAsPath[]
    AS path information traversed by the BGP route entry.
    creationTime string
    Time when the VPN gateway route entry was created.
    destinationCidrBlock string
    Destination network segment of the VPN gateway route entry.
    id string
    Uniquely identifies the resource.
    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[GetVpnGatewayRouteAsPath]
    AS path information traversed by the BGP route entry.
    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.
    id str
    Uniquely identifies the resource.
    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>
    AS path information traversed by the BGP route entry.
    creationTime String
    Time when the VPN gateway route entry was created.
    destinationCidrBlock String
    Destination network segment of the VPN gateway route entry.
    id String
    Uniquely identifies the resource.
    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

    GetVpnGatewayRouteAsPath

    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.

    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.30
    published on Monday, May 25, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial