1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpn
  5. GatewayVcoRoute
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.vpn.GatewayVcoRoute

Explore with Pulumi AI

Provides a VPN Gateway Vco Route resource.

For information about VPN Gateway Vco Route and how to use it, see What is Vco Route.

NOTE: Available since v1.183.0+.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const defaultInstance = new alicloud.cen.Instance("default", {cenInstanceName: name});
const defaultTransitRouter = new alicloud.cen.TransitRouter("default", {
    cenId: defaultInstance.id,
    transitRouterDescription: name,
    transitRouterName: name,
});
const defaultTransitRouterCidr = new alicloud.cen.TransitRouterCidr("default", {
    transitRouterId: defaultTransitRouter.transitRouterId,
    cidr: "192.168.0.0/16",
    transitRouterCidrName: name,
    description: name,
    publishCidrRoute: true,
});
const _default = alicloud.cen.getTransitRouterAvailableResources({});
const defaultCustomerGateway = new alicloud.vpn.CustomerGateway("default", {
    customerGatewayName: name,
    ipAddress: "42.104.22.210",
    asn: "45014",
    description: name,
});
const defaultGatewayVpnAttachment = new alicloud.vpn.GatewayVpnAttachment("default", {
    customerGatewayId: defaultCustomerGateway.id,
    networkType: "public",
    localSubnet: "0.0.0.0/0",
    remoteSubnet: "0.0.0.0/0",
    effectImmediately: false,
    ikeConfig: {
        ikeAuthAlg: "md5",
        ikeEncAlg: "des",
        ikeVersion: "ikev2",
        ikeMode: "main",
        ikeLifetime: 86400,
        psk: "tf-examplevpn2",
        ikePfs: "group1",
        remoteId: "testbob2",
        localId: "testalice2",
    },
    ipsecConfig: {
        ipsecPfs: "group5",
        ipsecEncAlg: "des",
        ipsecAuthAlg: "md5",
        ipsecLifetime: 86400,
    },
    bgpConfig: {
        enable: true,
        localAsn: 45014,
        tunnelCidr: "169.254.11.0/30",
        localBgpIp: "169.254.11.1",
    },
    healthCheckConfig: {
        enable: true,
        sip: "192.168.1.1",
        dip: "10.0.0.1",
        interval: 10,
        retry: 10,
        policy: "revoke_route",
    },
    enableDpd: true,
    enableNatTraversal: true,
    vpnAttachmentName: name,
});
const defaultTransitRouterVpnAttachment = new alicloud.cen.TransitRouterVpnAttachment("default", {
    autoPublishRouteEnabled: false,
    transitRouterAttachmentDescription: name,
    transitRouterAttachmentName: name,
    cenId: defaultTransitRouter.cenId,
    transitRouterId: defaultTransitRouterCidr.transitRouterId,
    vpnId: defaultGatewayVpnAttachment.id,
    zones: [{
        zoneId: _default.then(_default => _default.resources?.[0]?.masterZones?.[0]),
    }],
});
const defaultGatewayVcoRoute = new alicloud.vpn.GatewayVcoRoute("default", {
    nextHop: defaultTransitRouterVpnAttachment.vpnId,
    vpnConnectionId: defaultTransitRouterVpnAttachment.vpnId,
    weight: 100,
    routeDest: "192.168.10.0/24",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
default_instance = alicloud.cen.Instance("default", cen_instance_name=name)
default_transit_router = alicloud.cen.TransitRouter("default",
    cen_id=default_instance.id,
    transit_router_description=name,
    transit_router_name=name)
default_transit_router_cidr = alicloud.cen.TransitRouterCidr("default",
    transit_router_id=default_transit_router.transit_router_id,
    cidr="192.168.0.0/16",
    transit_router_cidr_name=name,
    description=name,
    publish_cidr_route=True)
default = alicloud.cen.get_transit_router_available_resources()
default_customer_gateway = alicloud.vpn.CustomerGateway("default",
    customer_gateway_name=name,
    ip_address="42.104.22.210",
    asn="45014",
    description=name)
default_gateway_vpn_attachment = alicloud.vpn.GatewayVpnAttachment("default",
    customer_gateway_id=default_customer_gateway.id,
    network_type="public",
    local_subnet="0.0.0.0/0",
    remote_subnet="0.0.0.0/0",
    effect_immediately=False,
    ike_config={
        "ike_auth_alg": "md5",
        "ike_enc_alg": "des",
        "ike_version": "ikev2",
        "ike_mode": "main",
        "ike_lifetime": 86400,
        "psk": "tf-examplevpn2",
        "ike_pfs": "group1",
        "remote_id": "testbob2",
        "local_id": "testalice2",
    },
    ipsec_config={
        "ipsec_pfs": "group5",
        "ipsec_enc_alg": "des",
        "ipsec_auth_alg": "md5",
        "ipsec_lifetime": 86400,
    },
    bgp_config={
        "enable": True,
        "local_asn": 45014,
        "tunnel_cidr": "169.254.11.0/30",
        "local_bgp_ip": "169.254.11.1",
    },
    health_check_config={
        "enable": True,
        "sip": "192.168.1.1",
        "dip": "10.0.0.1",
        "interval": 10,
        "retry": 10,
        "policy": "revoke_route",
    },
    enable_dpd=True,
    enable_nat_traversal=True,
    vpn_attachment_name=name)
default_transit_router_vpn_attachment = alicloud.cen.TransitRouterVpnAttachment("default",
    auto_publish_route_enabled=False,
    transit_router_attachment_description=name,
    transit_router_attachment_name=name,
    cen_id=default_transit_router.cen_id,
    transit_router_id=default_transit_router_cidr.transit_router_id,
    vpn_id=default_gateway_vpn_attachment.id,
    zones=[{
        "zone_id": default.resources[0].master_zones[0],
    }])
default_gateway_vco_route = alicloud.vpn.GatewayVcoRoute("default",
    next_hop=default_transit_router_vpn_attachment.vpn_id,
    vpn_connection_id=default_transit_router_vpn_attachment.vpn_id,
    weight=100,
    route_dest="192.168.10.0/24")
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		defaultInstance, err := cen.NewInstance(ctx, "default", &cen.InstanceArgs{
			CenInstanceName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultTransitRouter, err := cen.NewTransitRouter(ctx, "default", &cen.TransitRouterArgs{
			CenId:                    defaultInstance.ID(),
			TransitRouterDescription: pulumi.String(name),
			TransitRouterName:        pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultTransitRouterCidr, err := cen.NewTransitRouterCidr(ctx, "default", &cen.TransitRouterCidrArgs{
			TransitRouterId:       defaultTransitRouter.TransitRouterId,
			Cidr:                  pulumi.String("192.168.0.0/16"),
			TransitRouterCidrName: pulumi.String(name),
			Description:           pulumi.String(name),
			PublishCidrRoute:      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_default, err := cen.GetTransitRouterAvailableResources(ctx, &cen.GetTransitRouterAvailableResourcesArgs{}, nil)
		if err != nil {
			return err
		}
		defaultCustomerGateway, err := vpn.NewCustomerGateway(ctx, "default", &vpn.CustomerGatewayArgs{
			CustomerGatewayName: pulumi.String(name),
			IpAddress:           pulumi.String("42.104.22.210"),
			Asn:                 pulumi.String("45014"),
			Description:         pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultGatewayVpnAttachment, err := vpn.NewGatewayVpnAttachment(ctx, "default", &vpn.GatewayVpnAttachmentArgs{
			CustomerGatewayId: defaultCustomerGateway.ID(),
			NetworkType:       pulumi.String("public"),
			LocalSubnet:       pulumi.String("0.0.0.0/0"),
			RemoteSubnet:      pulumi.String("0.0.0.0/0"),
			EffectImmediately: pulumi.Bool(false),
			IkeConfig: &vpn.GatewayVpnAttachmentIkeConfigArgs{
				IkeAuthAlg:  pulumi.String("md5"),
				IkeEncAlg:   pulumi.String("des"),
				IkeVersion:  pulumi.String("ikev2"),
				IkeMode:     pulumi.String("main"),
				IkeLifetime: pulumi.Int(86400),
				Psk:         pulumi.String("tf-examplevpn2"),
				IkePfs:      pulumi.String("group1"),
				RemoteId:    pulumi.String("testbob2"),
				LocalId:     pulumi.String("testalice2"),
			},
			IpsecConfig: &vpn.GatewayVpnAttachmentIpsecConfigArgs{
				IpsecPfs:      pulumi.String("group5"),
				IpsecEncAlg:   pulumi.String("des"),
				IpsecAuthAlg:  pulumi.String("md5"),
				IpsecLifetime: pulumi.Int(86400),
			},
			BgpConfig: &vpn.GatewayVpnAttachmentBgpConfigArgs{
				Enable:     pulumi.Bool(true),
				LocalAsn:   pulumi.Int(45014),
				TunnelCidr: pulumi.String("169.254.11.0/30"),
				LocalBgpIp: pulumi.String("169.254.11.1"),
			},
			HealthCheckConfig: &vpn.GatewayVpnAttachmentHealthCheckConfigArgs{
				Enable:   pulumi.Bool(true),
				Sip:      pulumi.String("192.168.1.1"),
				Dip:      pulumi.String("10.0.0.1"),
				Interval: pulumi.Int(10),
				Retry:    pulumi.Int(10),
				Policy:   pulumi.String("revoke_route"),
			},
			EnableDpd:          pulumi.Bool(true),
			EnableNatTraversal: pulumi.Bool(true),
			VpnAttachmentName:  pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultTransitRouterVpnAttachment, err := cen.NewTransitRouterVpnAttachment(ctx, "default", &cen.TransitRouterVpnAttachmentArgs{
			AutoPublishRouteEnabled:            pulumi.Bool(false),
			TransitRouterAttachmentDescription: pulumi.String(name),
			TransitRouterAttachmentName:        pulumi.String(name),
			CenId:                              defaultTransitRouter.CenId,
			TransitRouterId:                    defaultTransitRouterCidr.TransitRouterId,
			VpnId:                              defaultGatewayVpnAttachment.ID(),
			Zones: cen.TransitRouterVpnAttachmentZoneArray{
				&cen.TransitRouterVpnAttachmentZoneArgs{
					ZoneId: pulumi.String(_default.Resources[0].MasterZones[0]),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = vpn.NewGatewayVcoRoute(ctx, "default", &vpn.GatewayVcoRouteArgs{
			NextHop:         defaultTransitRouterVpnAttachment.VpnId,
			VpnConnectionId: defaultTransitRouterVpnAttachment.VpnId,
			Weight:          pulumi.Int(100),
			RouteDest:       pulumi.String("192.168.10.0/24"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf-example";
    var defaultInstance = new AliCloud.Cen.Instance("default", new()
    {
        CenInstanceName = name,
    });

    var defaultTransitRouter = new AliCloud.Cen.TransitRouter("default", new()
    {
        CenId = defaultInstance.Id,
        TransitRouterDescription = name,
        TransitRouterName = name,
    });

    var defaultTransitRouterCidr = new AliCloud.Cen.TransitRouterCidr("default", new()
    {
        TransitRouterId = defaultTransitRouter.TransitRouterId,
        Cidr = "192.168.0.0/16",
        TransitRouterCidrName = name,
        Description = name,
        PublishCidrRoute = true,
    });

    var @default = AliCloud.Cen.GetTransitRouterAvailableResources.Invoke();

    var defaultCustomerGateway = new AliCloud.Vpn.CustomerGateway("default", new()
    {
        CustomerGatewayName = name,
        IpAddress = "42.104.22.210",
        Asn = "45014",
        Description = name,
    });

    var defaultGatewayVpnAttachment = new AliCloud.Vpn.GatewayVpnAttachment("default", new()
    {
        CustomerGatewayId = defaultCustomerGateway.Id,
        NetworkType = "public",
        LocalSubnet = "0.0.0.0/0",
        RemoteSubnet = "0.0.0.0/0",
        EffectImmediately = false,
        IkeConfig = new AliCloud.Vpn.Inputs.GatewayVpnAttachmentIkeConfigArgs
        {
            IkeAuthAlg = "md5",
            IkeEncAlg = "des",
            IkeVersion = "ikev2",
            IkeMode = "main",
            IkeLifetime = 86400,
            Psk = "tf-examplevpn2",
            IkePfs = "group1",
            RemoteId = "testbob2",
            LocalId = "testalice2",
        },
        IpsecConfig = new AliCloud.Vpn.Inputs.GatewayVpnAttachmentIpsecConfigArgs
        {
            IpsecPfs = "group5",
            IpsecEncAlg = "des",
            IpsecAuthAlg = "md5",
            IpsecLifetime = 86400,
        },
        BgpConfig = new AliCloud.Vpn.Inputs.GatewayVpnAttachmentBgpConfigArgs
        {
            Enable = true,
            LocalAsn = 45014,
            TunnelCidr = "169.254.11.0/30",
            LocalBgpIp = "169.254.11.1",
        },
        HealthCheckConfig = new AliCloud.Vpn.Inputs.GatewayVpnAttachmentHealthCheckConfigArgs
        {
            Enable = true,
            Sip = "192.168.1.1",
            Dip = "10.0.0.1",
            Interval = 10,
            Retry = 10,
            Policy = "revoke_route",
        },
        EnableDpd = true,
        EnableNatTraversal = true,
        VpnAttachmentName = name,
    });

    var defaultTransitRouterVpnAttachment = new AliCloud.Cen.TransitRouterVpnAttachment("default", new()
    {
        AutoPublishRouteEnabled = false,
        TransitRouterAttachmentDescription = name,
        TransitRouterAttachmentName = name,
        CenId = defaultTransitRouter.CenId,
        TransitRouterId = defaultTransitRouterCidr.TransitRouterId,
        VpnId = defaultGatewayVpnAttachment.Id,
        Zones = new[]
        {
            new AliCloud.Cen.Inputs.TransitRouterVpnAttachmentZoneArgs
            {
                ZoneId = @default.Apply(@default => @default.Apply(getTransitRouterAvailableResourcesResult => getTransitRouterAvailableResourcesResult.Resources[0]?.MasterZones[0])),
            },
        },
    });

    var defaultGatewayVcoRoute = new AliCloud.Vpn.GatewayVcoRoute("default", new()
    {
        NextHop = defaultTransitRouterVpnAttachment.VpnId,
        VpnConnectionId = defaultTransitRouterVpnAttachment.VpnId,
        Weight = 100,
        RouteDest = "192.168.10.0/24",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cen.Instance;
import com.pulumi.alicloud.cen.InstanceArgs;
import com.pulumi.alicloud.cen.TransitRouter;
import com.pulumi.alicloud.cen.TransitRouterArgs;
import com.pulumi.alicloud.cen.TransitRouterCidr;
import com.pulumi.alicloud.cen.TransitRouterCidrArgs;
import com.pulumi.alicloud.cen.CenFunctions;
import com.pulumi.alicloud.cen.inputs.GetTransitRouterAvailableResourcesArgs;
import com.pulumi.alicloud.vpn.CustomerGateway;
import com.pulumi.alicloud.vpn.CustomerGatewayArgs;
import com.pulumi.alicloud.vpn.GatewayVpnAttachment;
import com.pulumi.alicloud.vpn.GatewayVpnAttachmentArgs;
import com.pulumi.alicloud.vpn.inputs.GatewayVpnAttachmentIkeConfigArgs;
import com.pulumi.alicloud.vpn.inputs.GatewayVpnAttachmentIpsecConfigArgs;
import com.pulumi.alicloud.vpn.inputs.GatewayVpnAttachmentBgpConfigArgs;
import com.pulumi.alicloud.vpn.inputs.GatewayVpnAttachmentHealthCheckConfigArgs;
import com.pulumi.alicloud.cen.TransitRouterVpnAttachment;
import com.pulumi.alicloud.cen.TransitRouterVpnAttachmentArgs;
import com.pulumi.alicloud.cen.inputs.TransitRouterVpnAttachmentZoneArgs;
import com.pulumi.alicloud.vpn.GatewayVcoRoute;
import com.pulumi.alicloud.vpn.GatewayVcoRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("tf-example");
        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .cenInstanceName(name)
            .build());

        var defaultTransitRouter = new TransitRouter("defaultTransitRouter", TransitRouterArgs.builder()
            .cenId(defaultInstance.id())
            .transitRouterDescription(name)
            .transitRouterName(name)
            .build());

        var defaultTransitRouterCidr = new TransitRouterCidr("defaultTransitRouterCidr", TransitRouterCidrArgs.builder()
            .transitRouterId(defaultTransitRouter.transitRouterId())
            .cidr("192.168.0.0/16")
            .transitRouterCidrName(name)
            .description(name)
            .publishCidrRoute(true)
            .build());

        final var default = CenFunctions.getTransitRouterAvailableResources();

        var defaultCustomerGateway = new CustomerGateway("defaultCustomerGateway", CustomerGatewayArgs.builder()
            .customerGatewayName(name)
            .ipAddress("42.104.22.210")
            .asn("45014")
            .description(name)
            .build());

        var defaultGatewayVpnAttachment = new GatewayVpnAttachment("defaultGatewayVpnAttachment", GatewayVpnAttachmentArgs.builder()
            .customerGatewayId(defaultCustomerGateway.id())
            .networkType("public")
            .localSubnet("0.0.0.0/0")
            .remoteSubnet("0.0.0.0/0")
            .effectImmediately(false)
            .ikeConfig(GatewayVpnAttachmentIkeConfigArgs.builder()
                .ikeAuthAlg("md5")
                .ikeEncAlg("des")
                .ikeVersion("ikev2")
                .ikeMode("main")
                .ikeLifetime(86400)
                .psk("tf-examplevpn2")
                .ikePfs("group1")
                .remoteId("testbob2")
                .localId("testalice2")
                .build())
            .ipsecConfig(GatewayVpnAttachmentIpsecConfigArgs.builder()
                .ipsecPfs("group5")
                .ipsecEncAlg("des")
                .ipsecAuthAlg("md5")
                .ipsecLifetime(86400)
                .build())
            .bgpConfig(GatewayVpnAttachmentBgpConfigArgs.builder()
                .enable(true)
                .localAsn(45014)
                .tunnelCidr("169.254.11.0/30")
                .localBgpIp("169.254.11.1")
                .build())
            .healthCheckConfig(GatewayVpnAttachmentHealthCheckConfigArgs.builder()
                .enable(true)
                .sip("192.168.1.1")
                .dip("10.0.0.1")
                .interval(10)
                .retry(10)
                .policy("revoke_route")
                .build())
            .enableDpd(true)
            .enableNatTraversal(true)
            .vpnAttachmentName(name)
            .build());

        var defaultTransitRouterVpnAttachment = new TransitRouterVpnAttachment("defaultTransitRouterVpnAttachment", TransitRouterVpnAttachmentArgs.builder()
            .autoPublishRouteEnabled(false)
            .transitRouterAttachmentDescription(name)
            .transitRouterAttachmentName(name)
            .cenId(defaultTransitRouter.cenId())
            .transitRouterId(defaultTransitRouterCidr.transitRouterId())
            .vpnId(defaultGatewayVpnAttachment.id())
            .zones(TransitRouterVpnAttachmentZoneArgs.builder()
                .zoneId(default_.resources()[0].masterZones()[0])
                .build())
            .build());

        var defaultGatewayVcoRoute = new GatewayVcoRoute("defaultGatewayVcoRoute", GatewayVcoRouteArgs.builder()
            .nextHop(defaultTransitRouterVpnAttachment.vpnId())
            .vpnConnectionId(defaultTransitRouterVpnAttachment.vpnId())
            .weight("100")
            .routeDest("192.168.10.0/24")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: tf-example
resources:
  defaultInstance:
    type: alicloud:cen:Instance
    name: default
    properties:
      cenInstanceName: ${name}
  defaultTransitRouter:
    type: alicloud:cen:TransitRouter
    name: default
    properties:
      cenId: ${defaultInstance.id}
      transitRouterDescription: ${name}
      transitRouterName: ${name}
  defaultTransitRouterCidr:
    type: alicloud:cen:TransitRouterCidr
    name: default
    properties:
      transitRouterId: ${defaultTransitRouter.transitRouterId}
      cidr: 192.168.0.0/16
      transitRouterCidrName: ${name}
      description: ${name}
      publishCidrRoute: true
  defaultCustomerGateway:
    type: alicloud:vpn:CustomerGateway
    name: default
    properties:
      customerGatewayName: ${name}
      ipAddress: 42.104.22.210
      asn: '45014'
      description: ${name}
  defaultGatewayVpnAttachment:
    type: alicloud:vpn:GatewayVpnAttachment
    name: default
    properties:
      customerGatewayId: ${defaultCustomerGateway.id}
      networkType: public
      localSubnet: 0.0.0.0/0
      remoteSubnet: 0.0.0.0/0
      effectImmediately: false
      ikeConfig:
        ikeAuthAlg: md5
        ikeEncAlg: des
        ikeVersion: ikev2
        ikeMode: main
        ikeLifetime: 86400
        psk: tf-examplevpn2
        ikePfs: group1
        remoteId: testbob2
        localId: testalice2
      ipsecConfig:
        ipsecPfs: group5
        ipsecEncAlg: des
        ipsecAuthAlg: md5
        ipsecLifetime: 86400
      bgpConfig:
        enable: true
        localAsn: 45014
        tunnelCidr: 169.254.11.0/30
        localBgpIp: 169.254.11.1
      healthCheckConfig:
        enable: true
        sip: 192.168.1.1
        dip: 10.0.0.1
        interval: 10
        retry: 10
        policy: revoke_route
      enableDpd: true
      enableNatTraversal: true
      vpnAttachmentName: ${name}
  defaultTransitRouterVpnAttachment:
    type: alicloud:cen:TransitRouterVpnAttachment
    name: default
    properties:
      autoPublishRouteEnabled: false
      transitRouterAttachmentDescription: ${name}
      transitRouterAttachmentName: ${name}
      cenId: ${defaultTransitRouter.cenId}
      transitRouterId: ${defaultTransitRouterCidr.transitRouterId}
      vpnId: ${defaultGatewayVpnAttachment.id}
      zones:
        - zoneId: ${default.resources[0].masterZones[0]}
  defaultGatewayVcoRoute:
    type: alicloud:vpn:GatewayVcoRoute
    name: default
    properties:
      nextHop: ${defaultTransitRouterVpnAttachment.vpnId}
      vpnConnectionId: ${defaultTransitRouterVpnAttachment.vpnId}
      weight: '100'
      routeDest: 192.168.10.0/24
variables:
  default:
    fn::invoke:
      function: alicloud:cen:getTransitRouterAvailableResources
      arguments: {}
Copy

Create GatewayVcoRoute Resource

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

Constructor syntax

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

@overload
def GatewayVcoRoute(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    next_hop: Optional[str] = None,
                    route_dest: Optional[str] = None,
                    vpn_connection_id: Optional[str] = None,
                    weight: Optional[int] = None,
                    overlay_mode: Optional[str] = None)
func NewGatewayVcoRoute(ctx *Context, name string, args GatewayVcoRouteArgs, opts ...ResourceOption) (*GatewayVcoRoute, error)
public GatewayVcoRoute(string name, GatewayVcoRouteArgs args, CustomResourceOptions? opts = null)
public GatewayVcoRoute(String name, GatewayVcoRouteArgs args)
public GatewayVcoRoute(String name, GatewayVcoRouteArgs args, CustomResourceOptions options)
type: alicloud:vpn:GatewayVcoRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayVcoRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayVcoRouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayVcoRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayVcoRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayVcoRouteArgs
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 gatewayVcoRouteResource = new AliCloud.Vpn.GatewayVcoRoute("gatewayVcoRouteResource", new()
{
    NextHop = "string",
    RouteDest = "string",
    VpnConnectionId = "string",
    Weight = 0,
    OverlayMode = "string",
});
Copy
example, err := vpn.NewGatewayVcoRoute(ctx, "gatewayVcoRouteResource", &vpn.GatewayVcoRouteArgs{
	NextHop:         pulumi.String("string"),
	RouteDest:       pulumi.String("string"),
	VpnConnectionId: pulumi.String("string"),
	Weight:          pulumi.Int(0),
	OverlayMode:     pulumi.String("string"),
})
Copy
var gatewayVcoRouteResource = new GatewayVcoRoute("gatewayVcoRouteResource", GatewayVcoRouteArgs.builder()
    .nextHop("string")
    .routeDest("string")
    .vpnConnectionId("string")
    .weight(0)
    .overlayMode("string")
    .build());
Copy
gateway_vco_route_resource = alicloud.vpn.GatewayVcoRoute("gatewayVcoRouteResource",
    next_hop="string",
    route_dest="string",
    vpn_connection_id="string",
    weight=0,
    overlay_mode="string")
Copy
const gatewayVcoRouteResource = new alicloud.vpn.GatewayVcoRoute("gatewayVcoRouteResource", {
    nextHop: "string",
    routeDest: "string",
    vpnConnectionId: "string",
    weight: 0,
    overlayMode: "string",
});
Copy
type: alicloud:vpn:GatewayVcoRoute
properties:
    nextHop: string
    overlayMode: string
    routeDest: string
    vpnConnectionId: string
    weight: 0
Copy

GatewayVcoRoute 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 GatewayVcoRoute resource accepts the following input properties:

NextHop
This property is required.
Changes to this property will trigger replacement.
string
The next hop of the destination route.
RouteDest
This property is required.
Changes to this property will trigger replacement.
string
The destination network segment of the destination route.
VpnConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The id of the vpn attachment.
Weight
This property is required.
Changes to this property will trigger replacement.
int
The weight value of the destination route. Valid values: 0, 100.
OverlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
NextHop
This property is required.
Changes to this property will trigger replacement.
string
The next hop of the destination route.
RouteDest
This property is required.
Changes to this property will trigger replacement.
string
The destination network segment of the destination route.
VpnConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The id of the vpn attachment.
Weight
This property is required.
Changes to this property will trigger replacement.
int
The weight value of the destination route. Valid values: 0, 100.
OverlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
nextHop
This property is required.
Changes to this property will trigger replacement.
String
The next hop of the destination route.
routeDest
This property is required.
Changes to this property will trigger replacement.
String
The destination network segment of the destination route.
vpnConnectionId
This property is required.
Changes to this property will trigger replacement.
String
The id of the vpn attachment.
weight
This property is required.
Changes to this property will trigger replacement.
Integer
The weight value of the destination route. Valid values: 0, 100.
overlayMode Changes to this property will trigger replacement. String
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
nextHop
This property is required.
Changes to this property will trigger replacement.
string
The next hop of the destination route.
routeDest
This property is required.
Changes to this property will trigger replacement.
string
The destination network segment of the destination route.
vpnConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The id of the vpn attachment.
weight
This property is required.
Changes to this property will trigger replacement.
number
The weight value of the destination route. Valid values: 0, 100.
overlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
next_hop
This property is required.
Changes to this property will trigger replacement.
str
The next hop of the destination route.
route_dest
This property is required.
Changes to this property will trigger replacement.
str
The destination network segment of the destination route.
vpn_connection_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the vpn attachment.
weight
This property is required.
Changes to this property will trigger replacement.
int
The weight value of the destination route. Valid values: 0, 100.
overlay_mode Changes to this property will trigger replacement. str
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
nextHop
This property is required.
Changes to this property will trigger replacement.
String
The next hop of the destination route.
routeDest
This property is required.
Changes to this property will trigger replacement.
String
The destination network segment of the destination route.
vpnConnectionId
This property is required.
Changes to this property will trigger replacement.
String
The id of the vpn attachment.
weight
This property is required.
Changes to this property will trigger replacement.
Number
The weight value of the destination route. Valid values: 0, 100.
overlayMode Changes to this property will trigger replacement. String
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the vpn route entry.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the vpn route entry.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the vpn route entry.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the vpn route entry.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the vpn route entry.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the vpn route entry.

Look up Existing GatewayVcoRoute Resource

Get an existing GatewayVcoRoute 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?: GatewayVcoRouteState, opts?: CustomResourceOptions): GatewayVcoRoute
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        next_hop: Optional[str] = None,
        overlay_mode: Optional[str] = None,
        route_dest: Optional[str] = None,
        status: Optional[str] = None,
        vpn_connection_id: Optional[str] = None,
        weight: Optional[int] = None) -> GatewayVcoRoute
func GetGatewayVcoRoute(ctx *Context, name string, id IDInput, state *GatewayVcoRouteState, opts ...ResourceOption) (*GatewayVcoRoute, error)
public static GatewayVcoRoute Get(string name, Input<string> id, GatewayVcoRouteState? state, CustomResourceOptions? opts = null)
public static GatewayVcoRoute get(String name, Output<String> id, GatewayVcoRouteState state, CustomResourceOptions options)
resources:  _:    type: alicloud:vpn:GatewayVcoRoute    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
NextHop Changes to this property will trigger replacement. string
The next hop of the destination route.
OverlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
RouteDest Changes to this property will trigger replacement. string
The destination network segment of the destination route.
Status string
The status of the vpn route entry.
VpnConnectionId Changes to this property will trigger replacement. string
The id of the vpn attachment.
Weight Changes to this property will trigger replacement. int
The weight value of the destination route. Valid values: 0, 100.
NextHop Changes to this property will trigger replacement. string
The next hop of the destination route.
OverlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
RouteDest Changes to this property will trigger replacement. string
The destination network segment of the destination route.
Status string
The status of the vpn route entry.
VpnConnectionId Changes to this property will trigger replacement. string
The id of the vpn attachment.
Weight Changes to this property will trigger replacement. int
The weight value of the destination route. Valid values: 0, 100.
nextHop Changes to this property will trigger replacement. String
The next hop of the destination route.
overlayMode Changes to this property will trigger replacement. String
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
routeDest Changes to this property will trigger replacement. String
The destination network segment of the destination route.
status String
The status of the vpn route entry.
vpnConnectionId Changes to this property will trigger replacement. String
The id of the vpn attachment.
weight Changes to this property will trigger replacement. Integer
The weight value of the destination route. Valid values: 0, 100.
nextHop Changes to this property will trigger replacement. string
The next hop of the destination route.
overlayMode Changes to this property will trigger replacement. string
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
routeDest Changes to this property will trigger replacement. string
The destination network segment of the destination route.
status string
The status of the vpn route entry.
vpnConnectionId Changes to this property will trigger replacement. string
The id of the vpn attachment.
weight Changes to this property will trigger replacement. number
The weight value of the destination route. Valid values: 0, 100.
next_hop Changes to this property will trigger replacement. str
The next hop of the destination route.
overlay_mode Changes to this property will trigger replacement. str
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
route_dest Changes to this property will trigger replacement. str
The destination network segment of the destination route.
status str
The status of the vpn route entry.
vpn_connection_id Changes to this property will trigger replacement. str
The id of the vpn attachment.
weight Changes to this property will trigger replacement. int
The weight value of the destination route. Valid values: 0, 100.
nextHop Changes to this property will trigger replacement. String
The next hop of the destination route.
overlayMode Changes to this property will trigger replacement. String
The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol.
routeDest Changes to this property will trigger replacement. String
The destination network segment of the destination route.
status String
The status of the vpn route entry.
vpnConnectionId Changes to this property will trigger replacement. String
The id of the vpn attachment.
weight Changes to this property will trigger replacement. Number
The weight value of the destination route. Valid values: 0, 100.

Import

VPN Gateway Vco Route can be imported using the id, e.g.

$ pulumi import alicloud:vpn/gatewayVcoRoute:GatewayVcoRoute example <vpn_connection_id>:<route_dest>:<next_hop>:<weight>
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.