1. Packages
  2. Volcengine
  3. API Docs
  4. vpn
  5. getCustomerGateways
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.vpn.getCustomerGateways

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of customer gateways

    Example Usage

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

const fooCustomerGateway = new volcengine.vpn.CustomerGateway("fooCustomerGateway", {
    ipAddress: "192.0.1.3",
    customerGatewayName: "acc-test",
    description: "acc-test",
    projectName: "default",
});
const fooCustomerGateways = volcengine.vpn.getCustomerGatewaysOutput({
    ids: [fooCustomerGateway.id],
});

    import pulumi
import pulumi_volcengine as volcengine

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_customer_gateways = volcengine.vpn.get_customer_gateways_output(ids=[foo_customer_gateway.id])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		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
		}
		_ = vpn.GetCustomerGatewaysOutput(ctx, vpn.GetCustomerGatewaysOutputArgs{
			Ids: pulumi.StringArray{
				fooCustomerGateway.ID(),
			},
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

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

    var fooCustomerGateways = Volcengine.Vpn.GetCustomerGateways.Invoke(new()
    {
        Ids = new[]
        {
            fooCustomerGateway.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpn.CustomerGateway;
import com.pulumi.volcengine.vpn.CustomerGatewayArgs;
import com.pulumi.volcengine.vpn.VpnFunctions;
import com.pulumi.volcengine.vpn.inputs.GetCustomerGatewaysArgs;
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 fooCustomerGateway = new CustomerGateway("fooCustomerGateway", CustomerGatewayArgs.builder()        
            .ipAddress("192.0.1.3")
            .customerGatewayName("acc-test")
            .description("acc-test")
            .projectName("default")
            .build());

        final var fooCustomerGateways = VpnFunctions.getCustomerGateways(GetCustomerGatewaysArgs.builder()
            .ids(fooCustomerGateway.id())
            .build());

    }
}

    resources:
  fooCustomerGateway:
    type: volcengine:vpn:CustomerGateway
    properties:
      ipAddress: 192.0.1.3
      customerGatewayName: acc-test
      description: acc-test
      projectName: default
variables:
  fooCustomerGateways:
    fn::invoke:
      Function: volcengine:vpn:getCustomerGateways
      Arguments:
        ids:
          - ${fooCustomerGateway.id}

    Using getCustomerGateways

    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 getCustomerGateways(args: GetCustomerGatewaysArgs, opts?: InvokeOptions): Promise<GetCustomerGatewaysResult>
function getCustomerGatewaysOutput(args: GetCustomerGatewaysOutputArgs, opts?: InvokeOptions): Output<GetCustomerGatewaysResult>
    def get_customer_gateways(customer_gateway_names: Optional[Sequence[str]] = None,
                          ids: Optional[Sequence[str]] = None,
                          ip_address: Optional[str] = None,
                          ip_version: Optional[str] = None,
                          name_regex: Optional[str] = None,
                          output_file: Optional[str] = None,
                          project_name: Optional[str] = None,
                          status: Optional[str] = None,
                          tags: Optional[Sequence[GetCustomerGatewaysTag]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCustomerGatewaysResult
def get_customer_gateways_output(customer_gateway_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          ip_address: Optional[pulumi.Input[str]] = None,
                          ip_version: Optional[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,
                          status: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetCustomerGatewaysTagArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCustomerGatewaysResult]
    func GetCustomerGateways(ctx *Context, args *GetCustomerGatewaysArgs, opts ...InvokeOption) (*GetCustomerGatewaysResult, error)
func GetCustomerGatewaysOutput(ctx *Context, args *GetCustomerGatewaysOutputArgs, opts ...InvokeOption) GetCustomerGatewaysResultOutput

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

    public static class GetCustomerGateways 
{
    public static Task<GetCustomerGatewaysResult> InvokeAsync(GetCustomerGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomerGatewaysResult> Invoke(GetCustomerGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomerGatewaysResult> getCustomerGateways(GetCustomerGatewaysArgs args, InvokeOptions options)
public static Output<GetCustomerGatewaysResult> getCustomerGateways(GetCustomerGatewaysArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CustomerGatewayNames List<string>
    A list of customer gateway names.
    Ids List<string>
    A list of customer gateway ids.
    IpAddress string
    A IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    NameRegex string
    A Name Regex of customer gateway.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    Tags List<GetCustomerGatewaysTag>
    Tags.
    CustomerGatewayNames []string
    A list of customer gateway names.
    Ids []string
    A list of customer gateway ids.
    IpAddress string
    A IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    NameRegex string
    A Name Regex of customer gateway.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    Tags []GetCustomerGatewaysTag
    Tags.
    customerGatewayNames List<String>
    A list of customer gateway names.
    ids List<String>
    A list of customer gateway ids.
    ipAddress String
    A IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    nameRegex String
    A Name Regex of customer gateway.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags List<GetCustomerGatewaysTag>
    Tags.
    customerGatewayNames string[]
    A list of customer gateway names.
    ids string[]
    A list of customer gateway ids.
    ipAddress string
    A IP address of the customer gateway.
    ipVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    nameRegex string
    A Name Regex of customer gateway.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of the VPN customer gateway.
    status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags GetCustomerGatewaysTag[]
    Tags.
    customer_gateway_names Sequence[str]
    A list of customer gateway names.
    ids Sequence[str]
    A list of customer gateway ids.
    ip_address str
    A IP address of the customer gateway.
    ip_version str
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    name_regex str
    A Name Regex of customer gateway.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of the VPN customer gateway.
    status str
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags Sequence[GetCustomerGatewaysTag]
    Tags.
    customerGatewayNames List<String>
    A list of customer gateway names.
    ids List<String>
    A list of customer gateway ids.
    ipAddress String
    A IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    nameRegex String
    A Name Regex of customer gateway.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags List<Property Map>
    Tags.

    getCustomerGateways Result

    The following output properties are available:

    CustomerGateways List<GetCustomerGatewaysCustomerGateway>
    The collection of customer gateway query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of customer gateway query.
    CustomerGatewayNames List<string>
    Ids List<string>
    IpAddress string
    The IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway.
    Tags List<GetCustomerGatewaysTag>
    Tags.
    CustomerGateways []GetCustomerGatewaysCustomerGateway
    The collection of customer gateway query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of customer gateway query.
    CustomerGatewayNames []string
    Ids []string
    IpAddress string
    The IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway.
    Tags []GetCustomerGatewaysTag
    Tags.
    customerGateways List<GetCustomerGatewaysCustomerGateway>
    The collection of customer gateway query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of customer gateway query.
    customerGatewayNames List<String>
    ids List<String>
    ipAddress String
    The IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway.
    nameRegex String
    outputFile String
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway.
    tags List<GetCustomerGatewaysTag>
    Tags.
    customerGateways GetCustomerGatewaysCustomerGateway[]
    The collection of customer gateway query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of customer gateway query.
    customerGatewayNames string[]
    ids string[]
    ipAddress string
    The IP address of the customer gateway.
    ipVersion string
    The IP version of the customer gateway.
    nameRegex string
    outputFile string
    projectName string
    The project name of the VPN customer gateway.
    status string
    The status of the customer gateway.
    tags GetCustomerGatewaysTag[]
    Tags.
    customer_gateways Sequence[GetCustomerGatewaysCustomerGateway]
    The collection of customer gateway query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of customer gateway query.
    customer_gateway_names Sequence[str]
    ids Sequence[str]
    ip_address str
    The IP address of the customer gateway.
    ip_version str
    The IP version of the customer gateway.
    name_regex str
    output_file str
    project_name str
    The project name of the VPN customer gateway.
    status str
    The status of the customer gateway.
    tags Sequence[GetCustomerGatewaysTag]
    Tags.
    customerGateways List<Property Map>
    The collection of customer gateway query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of customer gateway query.
    customerGatewayNames List<String>
    ids List<String>
    ipAddress String
    The IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway.
    nameRegex String
    outputFile String
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway.
    tags List<Property Map>
    Tags.

    Supporting Types

    GetCustomerGatewaysCustomerGateway

    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    Id string
    The ID of the customer gateway.
    IpAddress string
    A IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    Tags List<GetCustomerGatewaysCustomerGatewayTag>
    Tags.
    UpdateTime string
    The update time of customer gateway.
    AccountId string
    The account ID of the customer gateway.
    ConnectionCount int
    The connection count of the customer gateway.
    CreationTime string
    The create time of customer gateway.
    CustomerGatewayId string
    The ID of the customer gateway.
    CustomerGatewayName string
    The name of the customer gateway.
    Description string
    The description of the customer gateway.
    Id string
    The ID of the customer gateway.
    IpAddress string
    A IP address of the customer gateway.
    IpVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    ProjectName string
    The project name of the VPN customer gateway.
    Status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    Tags []GetCustomerGatewaysCustomerGatewayTag
    Tags.
    UpdateTime string
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Integer
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    id String
    The ID of the customer gateway.
    ipAddress String
    A IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags List<GetCustomerGatewaysCustomerGatewayTag>
    Tags.
    updateTime String
    The update time of customer gateway.
    accountId string
    The account ID of the customer gateway.
    connectionCount number
    The connection count of the customer gateway.
    creationTime string
    The create time of customer gateway.
    customerGatewayId string
    The ID of the customer gateway.
    customerGatewayName string
    The name of the customer gateway.
    description string
    The description of the customer gateway.
    id string
    The ID of the customer gateway.
    ipAddress string
    A IP address of the customer gateway.
    ipVersion string
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    projectName string
    The project name of the VPN customer gateway.
    status string
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags GetCustomerGatewaysCustomerGatewayTag[]
    Tags.
    updateTime string
    The update time of customer gateway.
    account_id str
    The account ID of the customer gateway.
    connection_count int
    The connection count of the customer gateway.
    creation_time str
    The create time of customer gateway.
    customer_gateway_id str
    The ID of the customer gateway.
    customer_gateway_name str
    The name of the customer gateway.
    description str
    The description of the customer gateway.
    id str
    The ID of the customer gateway.
    ip_address str
    A IP address of the customer gateway.
    ip_version str
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    project_name str
    The project name of the VPN customer gateway.
    status str
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags Sequence[GetCustomerGatewaysCustomerGatewayTag]
    Tags.
    update_time str
    The update time of customer gateway.
    accountId String
    The account ID of the customer gateway.
    connectionCount Number
    The connection count of the customer gateway.
    creationTime String
    The create time of customer gateway.
    customerGatewayId String
    The ID of the customer gateway.
    customerGatewayName String
    The name of the customer gateway.
    description String
    The description of the customer gateway.
    id String
    The ID of the customer gateway.
    ipAddress String
    A IP address of the customer gateway.
    ipVersion String
    The IP version of the customer gateway. Valid value: ipv4, ipv6.
    projectName String
    The project name of the VPN customer gateway.
    status String
    The status of the customer gateway. Valid value: Creating, Deleting, Pending, Available.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of customer gateway.

    GetCustomerGatewaysCustomerGatewayTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetCustomerGatewaysTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.