Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vpn
  5. GatewayRoute
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.vpn.GatewayRoute

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage vpn gateway route

Example Usage

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

const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: "cn-beijing-a",
    vpcId: fooVpc.id,
});
const fooGateway = new volcengine.vpn.Gateway("fooGateway", {
    vpcId: fooVpc.id,
    subnetId: fooSubnet.id,
    bandwidth: 20,
    vpnGatewayName: "acc-test",
    description: "acc-test",
    period: 2,
    projectName: "default",
});
const fooCustomerGateway = new volcengine.vpn.CustomerGateway("fooCustomerGateway", {
    ipAddress: "192.0.1.3",
    customerGatewayName: "acc-test",
    description: "acc-test",
    projectName: "default",
});
const fooConnection = new volcengine.vpn.Connection("fooConnection", {
    vpnConnectionName: "acc-tf-test",
    description: "acc-tf-test",
    vpnGatewayId: fooGateway.id,
    customerGatewayId: fooCustomerGateway.id,
    localSubnets: ["192.168.0.0/22"],
    remoteSubnets: ["192.161.0.0/20"],
    dpdAction: "none",
    natTraversal: true,
    ikeConfigPsk: "acctest@!3",
    ikeConfigVersion: "ikev1",
    ikeConfigMode: "main",
    ikeConfigEncAlg: "aes",
    ikeConfigAuthAlg: "md5",
    ikeConfigDhGroup: "group2",
    ikeConfigLifetime: 9000,
    ikeConfigLocalId: "acc_test",
    ikeConfigRemoteId: "acc_test",
    ipsecConfigEncAlg: "aes",
    ipsecConfigAuthAlg: "sha256",
    ipsecConfigDhGroup: "group2",
    ipsecConfigLifetime: 9000,
    projectName: "default",
    logEnabled: false,
});
const fooGatewayRoute = new volcengine.vpn.GatewayRoute("fooGatewayRoute", {
    vpnGatewayId: fooGateway.id,
    destinationCidrBlock: "192.168.0.0/20",
    nextHopId: fooConnection.id,
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id="cn-beijing-a",
    vpc_id=foo_vpc.id)
foo_gateway = volcengine.vpn.Gateway("fooGateway",
    vpc_id=foo_vpc.id,
    subnet_id=foo_subnet.id,
    bandwidth=20,
    vpn_gateway_name="acc-test",
    description="acc-test",
    period=2,
    project_name="default")
foo_customer_gateway = volcengine.vpn.CustomerGateway("fooCustomerGateway",
    ip_address="192.0.1.3",
    customer_gateway_name="acc-test",
    description="acc-test",
    project_name="default")
foo_connection = volcengine.vpn.Connection("fooConnection",
    vpn_connection_name="acc-tf-test",
    description="acc-tf-test",
    vpn_gateway_id=foo_gateway.id,
    customer_gateway_id=foo_customer_gateway.id,
    local_subnets=["192.168.0.0/22"],
    remote_subnets=["192.161.0.0/20"],
    dpd_action="none",
    nat_traversal=True,
    ike_config_psk="acctest@!3",
    ike_config_version="ikev1",
    ike_config_mode="main",
    ike_config_enc_alg="aes",
    ike_config_auth_alg="md5",
    ike_config_dh_group="group2",
    ike_config_lifetime=9000,
    ike_config_local_id="acc_test",
    ike_config_remote_id="acc_test",
    ipsec_config_enc_alg="aes",
    ipsec_config_auth_alg="sha256",
    ipsec_config_dh_group="group2",
    ipsec_config_lifetime=9000,
    project_name="default",
    log_enabled=False)
foo_gateway_route = volcengine.vpn.GatewayRoute("fooGatewayRoute",
    vpn_gateway_id=foo_gateway.id,
    destination_cidr_block="192.168.0.0/20",
    next_hop_id=foo_connection.id)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpn"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String("cn-beijing-a"),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooGateway, err := vpn.NewGateway(ctx, "fooGateway", &vpn.GatewayArgs{
			VpcId:          fooVpc.ID(),
			SubnetId:       fooSubnet.ID(),
			Bandwidth:      pulumi.Int(20),
			VpnGatewayName: pulumi.String("acc-test"),
			Description:    pulumi.String("acc-test"),
			Period:         pulumi.Int(2),
			ProjectName:    pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		fooCustomerGateway, err := vpn.NewCustomerGateway(ctx, "fooCustomerGateway", &vpn.CustomerGatewayArgs{
			IpAddress:           pulumi.String("192.0.1.3"),
			CustomerGatewayName: pulumi.String("acc-test"),
			Description:         pulumi.String("acc-test"),
			ProjectName:         pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		fooConnection, err := vpn.NewConnection(ctx, "fooConnection", &vpn.ConnectionArgs{
			VpnConnectionName: pulumi.String("acc-tf-test"),
			Description:       pulumi.String("acc-tf-test"),
			VpnGatewayId:      fooGateway.ID(),
			CustomerGatewayId: fooCustomerGateway.ID(),
			LocalSubnets: pulumi.StringArray{
				pulumi.String("192.168.0.0/22"),
			},
			RemoteSubnets: pulumi.StringArray{
				pulumi.String("192.161.0.0/20"),
			},
			DpdAction:           pulumi.String("none"),
			NatTraversal:        pulumi.Bool(true),
			IkeConfigPsk:        pulumi.String("acctest@!3"),
			IkeConfigVersion:    pulumi.String("ikev1"),
			IkeConfigMode:       pulumi.String("main"),
			IkeConfigEncAlg:     pulumi.String("aes"),
			IkeConfigAuthAlg:    pulumi.String("md5"),
			IkeConfigDhGroup:    pulumi.String("group2"),
			IkeConfigLifetime:   pulumi.Int(9000),
			IkeConfigLocalId:    pulumi.String("acc_test"),
			IkeConfigRemoteId:   pulumi.String("acc_test"),
			IpsecConfigEncAlg:   pulumi.String("aes"),
			IpsecConfigAuthAlg:  pulumi.String("sha256"),
			IpsecConfigDhGroup:  pulumi.String("group2"),
			IpsecConfigLifetime: pulumi.Int(9000),
			ProjectName:         pulumi.String("default"),
			LogEnabled:          pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = vpn.NewGatewayRoute(ctx, "fooGatewayRoute", &vpn.GatewayRouteArgs{
			VpnGatewayId:         fooGateway.ID(),
			DestinationCidrBlock: pulumi.String("192.168.0.0/20"),
			NextHopId:            fooConnection.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = "cn-beijing-a",
        VpcId = fooVpc.Id,
    });

    var fooGateway = new Volcengine.Vpn.Gateway("fooGateway", new()
    {
        VpcId = fooVpc.Id,
        SubnetId = fooSubnet.Id,
        Bandwidth = 20,
        VpnGatewayName = "acc-test",
        Description = "acc-test",
        Period = 2,
        ProjectName = "default",
    });

    var fooCustomerGateway = new Volcengine.Vpn.CustomerGateway("fooCustomerGateway", new()
    {
        IpAddress = "192.0.1.3",
        CustomerGatewayName = "acc-test",
        Description = "acc-test",
        ProjectName = "default",
    });

    var fooConnection = new Volcengine.Vpn.Connection("fooConnection", new()
    {
        VpnConnectionName = "acc-tf-test",
        Description = "acc-tf-test",
        VpnGatewayId = fooGateway.Id,
        CustomerGatewayId = fooCustomerGateway.Id,
        LocalSubnets = new[]
        {
            "192.168.0.0/22",
        },
        RemoteSubnets = new[]
        {
            "192.161.0.0/20",
        },
        DpdAction = "none",
        NatTraversal = true,
        IkeConfigPsk = "acctest@!3",
        IkeConfigVersion = "ikev1",
        IkeConfigMode = "main",
        IkeConfigEncAlg = "aes",
        IkeConfigAuthAlg = "md5",
        IkeConfigDhGroup = "group2",
        IkeConfigLifetime = 9000,
        IkeConfigLocalId = "acc_test",
        IkeConfigRemoteId = "acc_test",
        IpsecConfigEncAlg = "aes",
        IpsecConfigAuthAlg = "sha256",
        IpsecConfigDhGroup = "group2",
        IpsecConfigLifetime = 9000,
        ProjectName = "default",
        LogEnabled = false,
    });

    var fooGatewayRoute = new Volcengine.Vpn.GatewayRoute("fooGatewayRoute", new()
    {
        VpnGatewayId = fooGateway.Id,
        DestinationCidrBlock = "192.168.0.0/20",
        NextHopId = fooConnection.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.vpn.Gateway;
import com.pulumi.volcengine.vpn.GatewayArgs;
import com.pulumi.volcengine.vpn.CustomerGateway;
import com.pulumi.volcengine.vpn.CustomerGatewayArgs;
import com.pulumi.volcengine.vpn.Connection;
import com.pulumi.volcengine.vpn.ConnectionArgs;
import com.pulumi.volcengine.vpn.GatewayRoute;
import com.pulumi.volcengine.vpn.GatewayRouteArgs;
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 fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId("cn-beijing-a")
            .vpcId(fooVpc.id())
            .build());

        var fooGateway = new Gateway("fooGateway", GatewayArgs.builder()        
            .vpcId(fooVpc.id())
            .subnetId(fooSubnet.id())
            .bandwidth(20)
            .vpnGatewayName("acc-test")
            .description("acc-test")
            .period(2)
            .projectName("default")
            .build());

        var fooCustomerGateway = new CustomerGateway("fooCustomerGateway", CustomerGatewayArgs.builder()        
            .ipAddress("192.0.1.3")
            .customerGatewayName("acc-test")
            .description("acc-test")
            .projectName("default")
            .build());

        var fooConnection = new Connection("fooConnection", ConnectionArgs.builder()        
            .vpnConnectionName("acc-tf-test")
            .description("acc-tf-test")
            .vpnGatewayId(fooGateway.id())
            .customerGatewayId(fooCustomerGateway.id())
            .localSubnets("192.168.0.0/22")
            .remoteSubnets("192.161.0.0/20")
            .dpdAction("none")
            .natTraversal(true)
            .ikeConfigPsk("acctest@!3")
            .ikeConfigVersion("ikev1")
            .ikeConfigMode("main")
            .ikeConfigEncAlg("aes")
            .ikeConfigAuthAlg("md5")
            .ikeConfigDhGroup("group2")
            .ikeConfigLifetime(9000)
            .ikeConfigLocalId("acc_test")
            .ikeConfigRemoteId("acc_test")
            .ipsecConfigEncAlg("aes")
            .ipsecConfigAuthAlg("sha256")
            .ipsecConfigDhGroup("group2")
            .ipsecConfigLifetime(9000)
            .projectName("default")
            .logEnabled(false)
            .build());

        var fooGatewayRoute = new GatewayRoute("fooGatewayRoute", GatewayRouteArgs.builder()        
            .vpnGatewayId(fooGateway.id())
            .destinationCidrBlock("192.168.0.0/20")
            .nextHopId(fooConnection.id())
            .build());

    }
}
Copy
resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: cn-beijing-a
      vpcId: ${fooVpc.id}
  fooGateway:
    type: volcengine:vpn:Gateway
    properties:
      vpcId: ${fooVpc.id}
      subnetId: ${fooSubnet.id}
      bandwidth: 20
      vpnGatewayName: acc-test
      description: acc-test
      period: 2
      projectName: default
  fooCustomerGateway:
    type: volcengine:vpn:CustomerGateway
    properties:
      ipAddress: 192.0.1.3
      customerGatewayName: acc-test
      description: acc-test
      projectName: default
  fooConnection:
    type: volcengine:vpn:Connection
    properties:
      vpnConnectionName: acc-tf-test
      description: acc-tf-test
      vpnGatewayId: ${fooGateway.id}
      customerGatewayId: ${fooCustomerGateway.id}
      localSubnets:
        - 192.168.0.0/22
      remoteSubnets:
        - 192.161.0.0/20
      dpdAction: none
      natTraversal: true
      ikeConfigPsk: acctest@!3
      ikeConfigVersion: ikev1
      ikeConfigMode: main
      ikeConfigEncAlg: aes
      ikeConfigAuthAlg: md5
      ikeConfigDhGroup: group2
      ikeConfigLifetime: 9000
      ikeConfigLocalId: acc_test
      ikeConfigRemoteId: acc_test
      ipsecConfigEncAlg: aes
      ipsecConfigAuthAlg: sha256
      ipsecConfigDhGroup: group2
      ipsecConfigLifetime: 9000
      projectName: default
      logEnabled: false
  fooGatewayRoute:
    type: volcengine:vpn:GatewayRoute
    properties:
      vpnGatewayId: ${fooGateway.id}
      destinationCidrBlock: 192.168.0.0/20
      nextHopId: ${fooConnection.id}
Copy

Create GatewayRoute Resource

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

Constructor syntax

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

@overload
def GatewayRoute(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 NewGatewayRoute(ctx *Context, name string, args GatewayRouteArgs, opts ...ResourceOption) (*GatewayRoute, error)
public GatewayRoute(string name, GatewayRouteArgs args, CustomResourceOptions? opts = null)
public GatewayRoute(String name, GatewayRouteArgs args)
public GatewayRoute(String name, GatewayRouteArgs args, CustomResourceOptions options)

type: volcengine:vpn:GatewayRoute
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. GatewayRouteArgs
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. GatewayRouteArgs
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. GatewayRouteArgs
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. GatewayRouteArgs
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. GatewayRouteArgs
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 volcengineGatewayRouteResource = new Volcengine.Vpn.GatewayRoute("volcengineGatewayRouteResource", new()
{
    DestinationCidrBlock = "string",
    NextHopId = "string",
    VpnGatewayId = "string",
});
Copy
example, err := vpn.NewGatewayRoute(ctx, "volcengineGatewayRouteResource", &vpn.GatewayRouteArgs{
	DestinationCidrBlock: pulumi.String("string"),
	NextHopId:            pulumi.String("string"),
	VpnGatewayId:         pulumi.String("string"),
})
Copy
var volcengineGatewayRouteResource = new GatewayRoute("volcengineGatewayRouteResource", GatewayRouteArgs.builder()
    .destinationCidrBlock("string")
    .nextHopId("string")
    .vpnGatewayId("string")
    .build());
Copy
volcengine_gateway_route_resource = volcengine.vpn.GatewayRoute("volcengineGatewayRouteResource",
    destination_cidr_block="string",
    next_hop_id="string",
    vpn_gateway_id="string")
Copy
const volcengineGatewayRouteResource = new volcengine.vpn.GatewayRoute("volcengineGatewayRouteResource", {
    destinationCidrBlock: "string",
    nextHopId: "string",
    vpnGatewayId: "string",
});
Copy
type: volcengine:vpn:GatewayRoute
properties:
    destinationCidrBlock: string
    nextHopId: string
    vpnGatewayId: string
Copy

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

DestinationCidrBlock
This property is required.
Changes to this property will trigger replacement.
string
The destination cidr block of the VPN gateway route.
NextHopId
This property is required.
Changes to this property will trigger replacement.
string
The next hop id of the VPN gateway route.
VpnGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN gateway of the VPN gateway route.
DestinationCidrBlock
This property is required.
Changes to this property will trigger replacement.
string
The destination cidr block of the VPN gateway route.
NextHopId
This property is required.
Changes to this property will trigger replacement.
string
The next hop id of the VPN gateway route.
VpnGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN gateway of the VPN gateway route.
destinationCidrBlock
This property is required.
Changes to this property will trigger replacement.
String
The destination cidr block of the VPN gateway route.
nextHopId
This property is required.
Changes to this property will trigger replacement.
String
The next hop id of the VPN gateway route.
vpnGatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPN gateway of the VPN gateway route.
destinationCidrBlock
This property is required.
Changes to this property will trigger replacement.
string
The destination cidr block of the VPN gateway route.
nextHopId
This property is required.
Changes to this property will trigger replacement.
string
The next hop id of the VPN gateway route.
vpnGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPN gateway of the VPN gateway route.
destination_cidr_block
This property is required.
Changes to this property will trigger replacement.
str
The destination cidr block of the VPN gateway route.
next_hop_id
This property is required.
Changes to this property will trigger replacement.
str
The next hop id of the VPN gateway route.
vpn_gateway_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the VPN gateway of the VPN gateway route.
destinationCidrBlock
This property is required.
Changes to this property will trigger replacement.
String
The destination cidr block of the VPN gateway route.
nextHopId
This property is required.
Changes to this property will trigger replacement.
String
The next hop id of the VPN gateway route.
vpnGatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPN gateway of the VPN gateway route.

Outputs

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

CreationTime string
The create time of VPN gateway route.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the VPN gateway route.
UpdateTime string
The update time of VPN gateway route.
VpnGatewayRouteId string
The ID of the VPN gateway route.
CreationTime string
The create time of VPN gateway route.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the VPN gateway route.
UpdateTime string
The update time of VPN gateway route.
VpnGatewayRouteId string
The ID of the VPN gateway route.
creationTime String
The create time of VPN gateway route.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the VPN gateway route.
updateTime String
The update time of VPN gateway route.
vpnGatewayRouteId String
The ID of the VPN gateway route.
creationTime string
The create time of VPN gateway route.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the VPN gateway route.
updateTime string
The update time of VPN gateway route.
vpnGatewayRouteId string
The ID of the VPN gateway route.
creation_time str
The create time of VPN gateway route.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the VPN gateway route.
update_time str
The update time of VPN gateway route.
vpn_gateway_route_id str
The ID of the VPN gateway route.
creationTime String
The create time of VPN gateway route.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the VPN gateway route.
updateTime String
The update time of VPN gateway route.
vpnGatewayRouteId String
The ID of the VPN gateway route.

Look up Existing GatewayRoute Resource

Get an existing GatewayRoute 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?: GatewayRouteState, opts?: CustomResourceOptions): GatewayRoute
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[str] = None,
        destination_cidr_block: Optional[str] = None,
        next_hop_id: 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) -> GatewayRoute
func GetGatewayRoute(ctx *Context, name string, id IDInput, state *GatewayRouteState, opts ...ResourceOption) (*GatewayRoute, error)
public static GatewayRoute Get(string name, Input<string> id, GatewayRouteState? state, CustomResourceOptions? opts = null)
public static GatewayRoute get(String name, Output<String> id, GatewayRouteState state, CustomResourceOptions options)
resources:  _:    type: volcengine:vpn:GatewayRoute    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:
CreationTime string
The create time of VPN gateway route.
DestinationCidrBlock Changes to this property will trigger replacement. string
The destination cidr block of the VPN gateway route.
NextHopId Changes to this property will trigger replacement. string
The next hop id of the VPN gateway route.
Status string
The status of the VPN gateway route.
UpdateTime string
The update time of VPN gateway route.
VpnGatewayId Changes to this property will trigger replacement. string
The ID of the VPN gateway of the VPN gateway route.
VpnGatewayRouteId string
The ID of the VPN gateway route.
CreationTime string
The create time of VPN gateway route.
DestinationCidrBlock Changes to this property will trigger replacement. string
The destination cidr block of the VPN gateway route.
NextHopId Changes to this property will trigger replacement. string
The next hop id of the VPN gateway route.
Status string
The status of the VPN gateway route.
UpdateTime string
The update time of VPN gateway route.
VpnGatewayId Changes to this property will trigger replacement. string
The ID of the VPN gateway of the VPN gateway route.
VpnGatewayRouteId string
The ID of the VPN gateway route.
creationTime String
The create time of VPN gateway route.
destinationCidrBlock Changes to this property will trigger replacement. String
The destination cidr block of the VPN gateway route.
nextHopId Changes to this property will trigger replacement. String
The next hop id of the VPN gateway route.
status String
The status of the VPN gateway route.
updateTime String
The update time of VPN gateway route.
vpnGatewayId Changes to this property will trigger replacement. String
The ID of the VPN gateway of the VPN gateway route.
vpnGatewayRouteId String
The ID of the VPN gateway route.
creationTime string
The create time of VPN gateway route.
destinationCidrBlock Changes to this property will trigger replacement. string
The destination cidr block of the VPN gateway route.
nextHopId Changes to this property will trigger replacement. string
The next hop id of the VPN gateway route.
status string
The status of the VPN gateway route.
updateTime string
The update time of VPN gateway route.
vpnGatewayId Changes to this property will trigger replacement. string
The ID of the VPN gateway of the VPN gateway route.
vpnGatewayRouteId string
The ID of the VPN gateway route.
creation_time str
The create time of VPN gateway route.
destination_cidr_block Changes to this property will trigger replacement. str
The destination cidr block of the VPN gateway route.
next_hop_id Changes to this property will trigger replacement. str
The next hop id of the VPN gateway route.
status str
The status of the VPN gateway route.
update_time str
The update time of VPN gateway route.
vpn_gateway_id Changes to this property will trigger replacement. str
The ID of the VPN gateway of the VPN gateway route.
vpn_gateway_route_id str
The ID of the VPN gateway route.
creationTime String
The create time of VPN gateway route.
destinationCidrBlock Changes to this property will trigger replacement. String
The destination cidr block of the VPN gateway route.
nextHopId Changes to this property will trigger replacement. String
The next hop id of the VPN gateway route.
status String
The status of the VPN gateway route.
updateTime String
The update time of VPN gateway route.
vpnGatewayId Changes to this property will trigger replacement. String
The ID of the VPN gateway of the VPN gateway route.
vpnGatewayRouteId String
The ID of the VPN gateway route.

Import

VpnGatewayRoute can be imported using the id, e.g.

$ pulumi import volcengine:vpn/gatewayRoute:GatewayRoute default vgr-3tex2c6c0v844c****
Copy

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

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine