volcengine.vpn.getConnections

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
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",
});
const fooConnections = volcengine.vpn.getConnectionsOutput({
    ids: [fooConnection.id],
});

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")
foo_connections = volcengine.vpn.get_connections_output(ids=[foo_connection.id])

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"),
		})
		if err != nil {
			return err
		}
		_ = vpn.GetConnectionsOutput(ctx, vpn.GetConnectionsOutputArgs{
			Ids: pulumi.StringArray{
				fooConnection.ID(),
			},
		}, nil)
		return nil
	})
}

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",
    });

    var fooConnections = Volcengine.Vpn.GetConnections.Invoke(new()
    {
        Ids = new[]
        {
            fooConnection.Id,
        },
    });

});

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.VpnFunctions;
import com.pulumi.volcengine.vpn.inputs.GetConnectionsArgs;
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")
            .build());

        final var fooConnections = VpnFunctions.getConnections(GetConnectionsArgs.builder()
            .ids(fooConnection.id())
            .build());

    }
}

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
variables:
  fooConnections:
    fn::invoke:
      Function: volcengine:vpn:getConnections
      Arguments:
        ids:
          - ${fooConnection.id}

Using getConnections

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 getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>
function getConnectionsOutput(args: GetConnectionsOutputArgs, opts?: InvokeOptions): Output<GetConnectionsResult>

def get_connections(attach_status: Optional[str] = None,
                    attach_type: Optional[str] = None,
                    customer_gateway_id: Optional[str] = None,
                    ids: Optional[Sequence[str]] = None,
                    name_regex: Optional[str] = None,
                    output_file: Optional[str] = None,
                    project_name: Optional[str] = None,
                    spec: Optional[str] = None,
                    status: Optional[str] = None,
                    transit_router_id: Optional[str] = None,
                    vpn_connection_names: Optional[Sequence[str]] = None,
                    vpn_gateway_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetConnectionsResult
def get_connections_output(attach_status: Optional[pulumi.Input[str]] = None,
                    attach_type: Optional[pulumi.Input[str]] = None,
                    customer_gateway_id: Optional[pulumi.Input[str]] = None,
                    ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    name_regex: Optional[pulumi.Input[str]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    project_name: Optional[pulumi.Input[str]] = None,
                    spec: Optional[pulumi.Input[str]] = None,
                    status: Optional[pulumi.Input[str]] = None,
                    transit_router_id: Optional[pulumi.Input[str]] = None,
                    vpn_connection_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    vpn_gateway_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetConnectionsResult]

func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)
func GetConnectionsOutput(ctx *Context, args *GetConnectionsOutputArgs, opts ...InvokeOption) GetConnectionsResultOutput

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

public static class GetConnections 
{
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionsResult> Invoke(GetConnectionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)
public static Output<GetConnectionsResult> getConnections(GetConnectionsArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:vpn/getConnections:getConnections
  arguments:
    # arguments dictionary

The following arguments are supported:

AttachStatus string: The attach status of VPN connection.
AttachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
CustomerGatewayId string: An ID of customer gateway.
Ids List<string>: A list of VPN connection ids.
NameRegex string: A Name Regex of VPN connection.
OutputFile string: File name where to save data source results.
ProjectName string: The project name of VPN connection.
Spec string: The spec of IPSec connection. Valid values: default, large.
Status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
TransitRouterId string: An ID of transit router.
VpnConnectionNames List<string>: A list of VPN connection names.
VpnGatewayId string: An ID of VPN gateway.

AttachStatus string: The attach status of VPN connection.
AttachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
CustomerGatewayId string: An ID of customer gateway.
Ids []string: A list of VPN connection ids.
NameRegex string: A Name Regex of VPN connection.
OutputFile string: File name where to save data source results.
ProjectName string: The project name of VPN connection.
Spec string: The spec of IPSec connection. Valid values: default, large.
Status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
TransitRouterId string: An ID of transit router.
VpnConnectionNames []string: A list of VPN connection names.
VpnGatewayId string: An ID of VPN gateway.

attachStatus String: The attach status of VPN connection.
attachType String: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
customerGatewayId String: An ID of customer gateway.
ids List<String>: A list of VPN connection ids.
nameRegex String: A Name Regex of VPN connection.
outputFile String: File name where to save data source results.
projectName String: The project name of VPN connection.
spec String: The spec of IPSec connection. Valid values: default, large.
status String: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId String: An ID of transit router.
vpnConnectionNames List<String>: A list of VPN connection names.
vpnGatewayId String: An ID of VPN gateway.

attachStatus string: The attach status of VPN connection.
attachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
customerGatewayId string: An ID of customer gateway.
ids string[]: A list of VPN connection ids.
nameRegex string: A Name Regex of VPN connection.
outputFile string: File name where to save data source results.
projectName string: The project name of VPN connection.
spec string: The spec of IPSec connection. Valid values: default, large.
status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId string: An ID of transit router.
vpnConnectionNames string[]: A list of VPN connection names.
vpnGatewayId string: An ID of VPN gateway.

attach_status str: The attach status of VPN connection.
attach_type str: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
customer_gateway_id str: An ID of customer gateway.
ids Sequence[str]: A list of VPN connection ids.
name_regex str: A Name Regex of VPN connection.
output_file str: File name where to save data source results.
project_name str: The project name of VPN connection.
spec str: The spec of IPSec connection. Valid values: default, large.
status str: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transit_router_id str: An ID of transit router.
vpn_connection_names Sequence[str]: A list of VPN connection names.
vpn_gateway_id str: An ID of VPN gateway.

attachStatus String: The attach status of VPN connection.
attachType String: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
customerGatewayId String: An ID of customer gateway.
ids List<String>: A list of VPN connection ids.
nameRegex String: A Name Regex of VPN connection.
outputFile String: File name where to save data source results.
projectName String: The project name of VPN connection.
spec String: The spec of IPSec connection. Valid values: default, large.
status String: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId String: An ID of transit router.
vpnConnectionNames List<String>: A list of VPN connection names.
vpnGatewayId String: An ID of VPN gateway.

getConnections Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of VPN connection query.
VpnConnections List<GetConnectionsVpnConnection>: The collection of VPN connection query.
AttachStatus string: The IPsec attach status.
AttachType string: The IPsec attach type.
CustomerGatewayId string: The ID of the customer gateway.
Ids List<string>
NameRegex string
OutputFile string
ProjectName string
Spec string
Status string: The status of the VPN connection.
TransitRouterId string: The id of transit router, valid when the attach type is 'TransitRouter'.
VpnConnectionNames List<string>
VpnGatewayId string: The ID of the vpn gateway.

Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of VPN connection query.
VpnConnections []GetConnectionsVpnConnection: The collection of VPN connection query.
AttachStatus string: The IPsec attach status.
AttachType string: The IPsec attach type.
CustomerGatewayId string: The ID of the customer gateway.
Ids []string
NameRegex string
OutputFile string
ProjectName string
Spec string
Status string: The status of the VPN connection.
TransitRouterId string: The id of transit router, valid when the attach type is 'TransitRouter'.
VpnConnectionNames []string
VpnGatewayId string: The ID of the vpn gateway.

id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of VPN connection query.
vpnConnections List<GetConnectionsVpnConnection>: The collection of VPN connection query.
attachStatus String: The IPsec attach status.
attachType String: The IPsec attach type.
customerGatewayId String: The ID of the customer gateway.
ids List<String>
nameRegex String
outputFile String
projectName String
spec String
status String: The status of the VPN connection.
transitRouterId String: The id of transit router, valid when the attach type is 'TransitRouter'.
vpnConnectionNames List<String>
vpnGatewayId String: The ID of the vpn gateway.

id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of VPN connection query.
vpnConnections GetConnectionsVpnConnection[]: The collection of VPN connection query.
attachStatus string: The IPsec attach status.
attachType string: The IPsec attach type.
customerGatewayId string: The ID of the customer gateway.
ids string[]
nameRegex string
outputFile string
projectName string
spec string
status string: The status of the VPN connection.
transitRouterId string: The id of transit router, valid when the attach type is 'TransitRouter'.
vpnConnectionNames string[]
vpnGatewayId string: The ID of the vpn gateway.

id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of VPN connection query.
vpn_connections Sequence[GetConnectionsVpnConnection]: The collection of VPN connection query.
attach_status str: The IPsec attach status.
attach_type str: The IPsec attach type.
customer_gateway_id str: The ID of the customer gateway.
ids Sequence[str]
name_regex str
output_file str
project_name str
spec str
status str: The status of the VPN connection.
transit_router_id str: The id of transit router, valid when the attach type is 'TransitRouter'.
vpn_connection_names Sequence[str]
vpn_gateway_id str: The ID of the vpn gateway.

id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of VPN connection query.
vpnConnections List<Property Map>: The collection of VPN connection query.
attachStatus String: The IPsec attach status.
attachType String: The IPsec attach type.
customerGatewayId String: The ID of the customer gateway.
ids List<String>
nameRegex String
outputFile String
projectName String
spec String
status String: The status of the VPN connection.
transitRouterId String: The id of transit router, valid when the attach type is 'TransitRouter'.
vpnConnectionNames List<String>
vpnGatewayId String: The ID of the vpn gateway.

Supporting Types

GetConnectionsVpnConnection

AccountId string: The account ID of the VPN connection.
AttachStatus string: The attach status of VPN connection.
AttachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
BusinessStatus string: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
ConnectStatus string: The connect status of the VPN connection.
CreationTime string: The create time of VPN connection.
CustomerGatewayId string: An ID of customer gateway.
DeletedTime string: The delete time of resource, valid when the attach type is 'TransitRouter'.
Description string: The description of the VPN connection.
DpdAction string: The dpd action of the VPN connection.
Id string: The ID of the VPN connection.
IkeConfigAuthAlg string: The auth alg of the ike config of the VPN connection.
IkeConfigDhGroup string: The dk group of the ike config of the VPN connection.
IkeConfigEncAlg string: The enc alg of the ike config of the VPN connection.
IkeConfigLifetime int: The lifetime of the ike config of the VPN connection.
IkeConfigLocalId string: The local_id of the ike config of the VPN connection.
IkeConfigMode string: The mode of the ike config of the VPN connection.
IkeConfigPsk string: The psk of the ike config of the VPN connection.
IkeConfigRemoteId string: The remote id of the ike config of the VPN connection.
IkeConfigVersion string: The version of the ike config of the VPN connection.
IpAddress string: The ip address of transit router, valid when the attach type is 'TransitRouter'.
IpsecConfigAuthAlg string: The auth alg of the ipsec config of the VPN connection.
IpsecConfigDhGroup string: The dh group of the ipsec config of the VPN connection.
IpsecConfigEncAlg string: The enc alg of the ipsec config of the VPN connection.
IpsecConfigLifetime int: The lifetime of the ike config of the VPN connection.
LocalSubnets List<string>: The local subnet of the VPN connection.
LogEnabled bool: Whether to enable the connection log.
NatTraversal bool: The nat traversal of the VPN connection.
NegotiateInstantly bool: Whether to initiate negotiation mode immediately.
OverdueTime string: The overdue time of resource, valid when the attach type is 'TransitRouter'.
RemoteSubnets List<string>: The remote subnet of the VPN connection.
Status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
TransitRouterId string: An ID of transit router.
UpdateTime string: The update time of VPN connection.
VpnConnectionId string: The ID of the VPN connection.
VpnConnectionName string: The name of the VPN connection.
VpnGatewayId string: An ID of VPN gateway.
ZoneId string: The zone id of transit router, valid when the attach type is 'TransitRouter'.

AccountId string: The account ID of the VPN connection.
AttachStatus string: The attach status of VPN connection.
AttachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
BusinessStatus string: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
ConnectStatus string: The connect status of the VPN connection.
CreationTime string: The create time of VPN connection.
CustomerGatewayId string: An ID of customer gateway.
DeletedTime string: The delete time of resource, valid when the attach type is 'TransitRouter'.
Description string: The description of the VPN connection.
DpdAction string: The dpd action of the VPN connection.
Id string: The ID of the VPN connection.
IkeConfigAuthAlg string: The auth alg of the ike config of the VPN connection.
IkeConfigDhGroup string: The dk group of the ike config of the VPN connection.
IkeConfigEncAlg string: The enc alg of the ike config of the VPN connection.
IkeConfigLifetime int: The lifetime of the ike config of the VPN connection.
IkeConfigLocalId string: The local_id of the ike config of the VPN connection.
IkeConfigMode string: The mode of the ike config of the VPN connection.
IkeConfigPsk string: The psk of the ike config of the VPN connection.
IkeConfigRemoteId string: The remote id of the ike config of the VPN connection.
IkeConfigVersion string: The version of the ike config of the VPN connection.
IpAddress string: The ip address of transit router, valid when the attach type is 'TransitRouter'.
IpsecConfigAuthAlg string: The auth alg of the ipsec config of the VPN connection.
IpsecConfigDhGroup string: The dh group of the ipsec config of the VPN connection.
IpsecConfigEncAlg string: The enc alg of the ipsec config of the VPN connection.
IpsecConfigLifetime int: The lifetime of the ike config of the VPN connection.
LocalSubnets []string: The local subnet of the VPN connection.
LogEnabled bool: Whether to enable the connection log.
NatTraversal bool: The nat traversal of the VPN connection.
NegotiateInstantly bool: Whether to initiate negotiation mode immediately.
OverdueTime string: The overdue time of resource, valid when the attach type is 'TransitRouter'.
RemoteSubnets []string: The remote subnet of the VPN connection.
Status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
TransitRouterId string: An ID of transit router.
UpdateTime string: The update time of VPN connection.
VpnConnectionId string: The ID of the VPN connection.
VpnConnectionName string: The name of the VPN connection.
VpnGatewayId string: An ID of VPN gateway.
ZoneId string: The zone id of transit router, valid when the attach type is 'TransitRouter'.

accountId String: The account ID of the VPN connection.
attachStatus String: The attach status of VPN connection.
attachType String: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
businessStatus String: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
connectStatus String: The connect status of the VPN connection.
creationTime String: The create time of VPN connection.
customerGatewayId String: An ID of customer gateway.
deletedTime String: The delete time of resource, valid when the attach type is 'TransitRouter'.
description String: The description of the VPN connection.
dpdAction String: The dpd action of the VPN connection.
id String: The ID of the VPN connection.
ikeConfigAuthAlg String: The auth alg of the ike config of the VPN connection.
ikeConfigDhGroup String: The dk group of the ike config of the VPN connection.
ikeConfigEncAlg String: The enc alg of the ike config of the VPN connection.
ikeConfigLifetime Integer: The lifetime of the ike config of the VPN connection.
ikeConfigLocalId String: The local_id of the ike config of the VPN connection.
ikeConfigMode String: The mode of the ike config of the VPN connection.
ikeConfigPsk String: The psk of the ike config of the VPN connection.
ikeConfigRemoteId String: The remote id of the ike config of the VPN connection.
ikeConfigVersion String: The version of the ike config of the VPN connection.
ipAddress String: The ip address of transit router, valid when the attach type is 'TransitRouter'.
ipsecConfigAuthAlg String: The auth alg of the ipsec config of the VPN connection.
ipsecConfigDhGroup String: The dh group of the ipsec config of the VPN connection.
ipsecConfigEncAlg String: The enc alg of the ipsec config of the VPN connection.
ipsecConfigLifetime Integer: The lifetime of the ike config of the VPN connection.
localSubnets List<String>: The local subnet of the VPN connection.
logEnabled Boolean: Whether to enable the connection log.
natTraversal Boolean: The nat traversal of the VPN connection.
negotiateInstantly Boolean: Whether to initiate negotiation mode immediately.
overdueTime String: The overdue time of resource, valid when the attach type is 'TransitRouter'.
remoteSubnets List<String>: The remote subnet of the VPN connection.
status String: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId String: An ID of transit router.
updateTime String: The update time of VPN connection.
vpnConnectionId String: The ID of the VPN connection.
vpnConnectionName String: The name of the VPN connection.
vpnGatewayId String: An ID of VPN gateway.
zoneId String: The zone id of transit router, valid when the attach type is 'TransitRouter'.

accountId string: The account ID of the VPN connection.
attachStatus string: The attach status of VPN connection.
attachType string: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
businessStatus string: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
connectStatus string: The connect status of the VPN connection.
creationTime string: The create time of VPN connection.
customerGatewayId string: An ID of customer gateway.
deletedTime string: The delete time of resource, valid when the attach type is 'TransitRouter'.
description string: The description of the VPN connection.
dpdAction string: The dpd action of the VPN connection.
id string: The ID of the VPN connection.
ikeConfigAuthAlg string: The auth alg of the ike config of the VPN connection.
ikeConfigDhGroup string: The dk group of the ike config of the VPN connection.
ikeConfigEncAlg string: The enc alg of the ike config of the VPN connection.
ikeConfigLifetime number: The lifetime of the ike config of the VPN connection.
ikeConfigLocalId string: The local_id of the ike config of the VPN connection.
ikeConfigMode string: The mode of the ike config of the VPN connection.
ikeConfigPsk string: The psk of the ike config of the VPN connection.
ikeConfigRemoteId string: The remote id of the ike config of the VPN connection.
ikeConfigVersion string: The version of the ike config of the VPN connection.
ipAddress string: The ip address of transit router, valid when the attach type is 'TransitRouter'.
ipsecConfigAuthAlg string: The auth alg of the ipsec config of the VPN connection.
ipsecConfigDhGroup string: The dh group of the ipsec config of the VPN connection.
ipsecConfigEncAlg string: The enc alg of the ipsec config of the VPN connection.
ipsecConfigLifetime number: The lifetime of the ike config of the VPN connection.
localSubnets string[]: The local subnet of the VPN connection.
logEnabled boolean: Whether to enable the connection log.
natTraversal boolean: The nat traversal of the VPN connection.
negotiateInstantly boolean: Whether to initiate negotiation mode immediately.
overdueTime string: The overdue time of resource, valid when the attach type is 'TransitRouter'.
remoteSubnets string[]: The remote subnet of the VPN connection.
status string: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId string: An ID of transit router.
updateTime string: The update time of VPN connection.
vpnConnectionId string: The ID of the VPN connection.
vpnConnectionName string: The name of the VPN connection.
vpnGatewayId string: An ID of VPN gateway.
zoneId string: The zone id of transit router, valid when the attach type is 'TransitRouter'.

account_id str: The account ID of the VPN connection.
attach_status str: The attach status of VPN connection.
attach_type str: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
business_status str: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
connect_status str: The connect status of the VPN connection.
creation_time str: The create time of VPN connection.
customer_gateway_id str: An ID of customer gateway.
deleted_time str: The delete time of resource, valid when the attach type is 'TransitRouter'.
description str: The description of the VPN connection.
dpd_action str: The dpd action of the VPN connection.
id str: The ID of the VPN connection.
ike_config_auth_alg str: The auth alg of the ike config of the VPN connection.
ike_config_dh_group str: The dk group of the ike config of the VPN connection.
ike_config_enc_alg str: The enc alg of the ike config of the VPN connection.
ike_config_lifetime int: The lifetime of the ike config of the VPN connection.
ike_config_local_id str: The local_id of the ike config of the VPN connection.
ike_config_mode str: The mode of the ike config of the VPN connection.
ike_config_psk str: The psk of the ike config of the VPN connection.
ike_config_remote_id str: The remote id of the ike config of the VPN connection.
ike_config_version str: The version of the ike config of the VPN connection.
ip_address str: The ip address of transit router, valid when the attach type is 'TransitRouter'.
ipsec_config_auth_alg str: The auth alg of the ipsec config of the VPN connection.
ipsec_config_dh_group str: The dh group of the ipsec config of the VPN connection.
ipsec_config_enc_alg str: The enc alg of the ipsec config of the VPN connection.
ipsec_config_lifetime int: The lifetime of the ike config of the VPN connection.
local_subnets Sequence[str]: The local subnet of the VPN connection.
log_enabled bool: Whether to enable the connection log.
nat_traversal bool: The nat traversal of the VPN connection.
negotiate_instantly bool: Whether to initiate negotiation mode immediately.
overdue_time str: The overdue time of resource, valid when the attach type is 'TransitRouter'.
remote_subnets Sequence[str]: The remote subnet of the VPN connection.
status str: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transit_router_id str: An ID of transit router.
update_time str: The update time of VPN connection.
vpn_connection_id str: The ID of the VPN connection.
vpn_connection_name str: The name of the VPN connection.
vpn_gateway_id str: An ID of VPN gateway.
zone_id str: The zone id of transit router, valid when the attach type is 'TransitRouter'.

accountId String: The account ID of the VPN connection.
attachStatus String: The attach status of VPN connection.
attachType String: The attach type of VPN connection. Valid values: VpnGateway, TransitRouter.
businessStatus String: The business status of IPsec connection, valid when the attach type is 'TransitRouter'.
connectStatus String: The connect status of the VPN connection.
creationTime String: The create time of VPN connection.
customerGatewayId String: An ID of customer gateway.
deletedTime String: The delete time of resource, valid when the attach type is 'TransitRouter'.
description String: The description of the VPN connection.
dpdAction String: The dpd action of the VPN connection.
id String: The ID of the VPN connection.
ikeConfigAuthAlg String: The auth alg of the ike config of the VPN connection.
ikeConfigDhGroup String: The dk group of the ike config of the VPN connection.
ikeConfigEncAlg String: The enc alg of the ike config of the VPN connection.
ikeConfigLifetime Number: The lifetime of the ike config of the VPN connection.
ikeConfigLocalId String: The local_id of the ike config of the VPN connection.
ikeConfigMode String: The mode of the ike config of the VPN connection.
ikeConfigPsk String: The psk of the ike config of the VPN connection.
ikeConfigRemoteId String: The remote id of the ike config of the VPN connection.
ikeConfigVersion String: The version of the ike config of the VPN connection.
ipAddress String: The ip address of transit router, valid when the attach type is 'TransitRouter'.
ipsecConfigAuthAlg String: The auth alg of the ipsec config of the VPN connection.
ipsecConfigDhGroup String: The dh group of the ipsec config of the VPN connection.
ipsecConfigEncAlg String: The enc alg of the ipsec config of the VPN connection.
ipsecConfigLifetime Number: The lifetime of the ike config of the VPN connection.
localSubnets List<String>: The local subnet of the VPN connection.
logEnabled Boolean: Whether to enable the connection log.
natTraversal Boolean: The nat traversal of the VPN connection.
negotiateInstantly Boolean: Whether to initiate negotiation mode immediately.
overdueTime String: The overdue time of resource, valid when the attach type is 'TransitRouter'.
remoteSubnets List<String>: The remote subnet of the VPN connection.
status String: The status of IPSec connection. Valid values: Creating, Deleting, Pending, Available.
transitRouterId String: An ID of transit router.
updateTime String: The update time of VPN connection.
vpnConnectionId String: The ID of the VPN connection.
vpnConnectionName String: The name of the VPN connection.
vpnGatewayId String: An ID of VPN gateway.
zoneId String: The zone id of transit router, valid when the attach type is 'TransitRouter'.

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.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.vpn.getConnections

On this page

On this page

Example Usage

Using getConnections

getConnections Result

Supporting Types

GetConnectionsVpnConnection

Package Details

On this page

On this page