Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine.vpn.CustomerGateways
Explore with Pulumi AI
Use this data source to query detailed information of customer gateways
Example Usage
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.CustomerGateways.Invoke(new()
    {
        Ids = new[]
        {
            fooCustomerGateway.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.CustomerGatewaysOutput(ctx, vpn.CustomerGatewaysOutputArgs{
			Ids: pulumi.StringArray{
				fooCustomerGateway.ID(),
			},
		}, nil)
		return nil
	})
}
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.CustomerGatewaysArgs;
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.CustomerGateways(CustomerGatewaysArgs.builder()
            .ids(fooCustomerGateway.id())
            .build());
    }
}
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.customer_gateways_output(ids=[foo_customer_gateway.id])
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.CustomerGatewaysOutput({
    ids: [fooCustomerGateway.id],
});
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:CustomerGateways
      Arguments:
        ids:
          - ${fooCustomerGateway.id}
Using CustomerGateways
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 customerGateways(args: CustomerGatewaysArgs, opts?: InvokeOptions): Promise<CustomerGatewaysResult>
function customerGatewaysOutput(args: CustomerGatewaysOutputArgs, opts?: InvokeOptions): Output<CustomerGatewaysResult>def customer_gateways(customer_gateway_names: Optional[Sequence[str]] = None,
                      ids: Optional[Sequence[str]] = None,
                      ip_address: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> CustomerGatewaysResult
def 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,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[CustomerGatewaysResult]func CustomerGateways(ctx *Context, args *CustomerGatewaysArgs, opts ...InvokeOption) (*CustomerGatewaysResult, error)
func CustomerGatewaysOutput(ctx *Context, args *CustomerGatewaysOutputArgs, opts ...InvokeOption) CustomerGatewaysResultOutputpublic static class CustomerGateways 
{
    public static Task<CustomerGatewaysResult> InvokeAsync(CustomerGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<CustomerGatewaysResult> Invoke(CustomerGatewaysInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<CustomerGatewaysResult> customerGateways(CustomerGatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: volcengine:vpn:CustomerGateways
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Customer
Gateway List<string>Names  - A list of customer gateway names.
 - Ids List<string>
 - A list of customer gateway ids.
 - Ip
Address string - A IP address of the customer gateway.
 - Name
Regex string - A Name Regex of customer gateway.
 - Output
File string - File name where to save data source results.
 
- Customer
Gateway []stringNames  - A list of customer gateway names.
 - Ids []string
 - A list of customer gateway ids.
 - Ip
Address string - A IP address of the customer gateway.
 - Name
Regex string - A Name Regex of customer gateway.
 - Output
File string - File name where to save data source results.
 
- customer
Gateway List<String>Names  - A list of customer gateway names.
 - ids List<String>
 - A list of customer gateway ids.
 - ip
Address String - A IP address of the customer gateway.
 - name
Regex String - A Name Regex of customer gateway.
 - output
File String - File name where to save data source results.
 
- customer
Gateway string[]Names  - A list of customer gateway names.
 - ids string[]
 - A list of customer gateway ids.
 - ip
Address string - A IP address of the customer gateway.
 - name
Regex string - A Name Regex of customer gateway.
 - output
File string - File name where to save data source results.
 
- customer_
gateway_ Sequence[str]names  - 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.
 - name_
regex str - A Name Regex of customer gateway.
 - output_
file str - File name where to save data source results.
 
- customer
Gateway List<String>Names  - A list of customer gateway names.
 - ids List<String>
 - A list of customer gateway ids.
 - ip
Address String - A IP address of the customer gateway.
 - name
Regex String - A Name Regex of customer gateway.
 - output
File String - File name where to save data source results.
 
CustomerGateways Result
The following output properties are available:
- Customer
Gateways List<CustomerGateways Customer Gateway>  - The collection of customer gateway query.
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Total
Count int - The total count of customer gateway query.
 - Customer
Gateway List<string>Names  - Ids List<string>
 - Ip
Address string - The IP address of the customer gateway.
 - Name
Regex string - Output
File string 
- Customer
Gateways []CustomerGateways Customer Gateway  - The collection of customer gateway query.
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Total
Count int - The total count of customer gateway query.
 - Customer
Gateway []stringNames  - Ids []string
 - Ip
Address string - The IP address of the customer gateway.
 - Name
Regex string - Output
File string 
- customer
Gateways List<CustomerGateways Customer Gateway>  - The collection of customer gateway query.
 - id String
 - The provider-assigned unique ID for this managed resource.
 - total
Count Integer - The total count of customer gateway query.
 - customer
Gateway List<String>Names  - ids List<String>
 - ip
Address String - The IP address of the customer gateway.
 - name
Regex String - output
File String 
- customer
Gateways CustomerGateways Customer Gateway[]  - The collection of customer gateway query.
 - id string
 - The provider-assigned unique ID for this managed resource.
 - total
Count number - The total count of customer gateway query.
 - customer
Gateway string[]Names  - ids string[]
 - ip
Address string - The IP address of the customer gateway.
 - name
Regex string - output
File string 
- customer_
gateways Sequence[CustomerGateways Customer Gateway]  - 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_ Sequence[str]names  - ids Sequence[str]
 - ip_
address str - The IP address of the customer gateway.
 - name_
regex str - output_
file str 
- customer
Gateways List<Property Map> - The collection of customer gateway query.
 - id String
 - The provider-assigned unique ID for this managed resource.
 - total
Count Number - The total count of customer gateway query.
 - customer
Gateway List<String>Names  - ids List<String>
 - ip
Address String - The IP address of the customer gateway.
 - name
Regex String - output
File String 
Supporting Types
CustomerGatewaysCustomerGateway   
- Account
Id string - The account ID of the customer gateway.
 - Connection
Count int - The connection count of the customer gateway.
 - Creation
Time string - The create time of customer gateway.
 - Customer
Gateway stringId  - The ID of the customer gateway.
 - Customer
Gateway stringName  - The name of the customer gateway.
 - Description string
 - The description of the customer gateway.
 - Id string
 - The ID of the customer gateway.
 - Ip
Address string - A IP address of the customer gateway.
 - Status string
 - The status of the customer gateway.
 - Update
Time string - The update time of customer gateway.
 
- Account
Id string - The account ID of the customer gateway.
 - Connection
Count int - The connection count of the customer gateway.
 - Creation
Time string - The create time of customer gateway.
 - Customer
Gateway stringId  - The ID of the customer gateway.
 - Customer
Gateway stringName  - The name of the customer gateway.
 - Description string
 - The description of the customer gateway.
 - Id string
 - The ID of the customer gateway.
 - Ip
Address string - A IP address of the customer gateway.
 - Status string
 - The status of the customer gateway.
 - Update
Time string - The update time of customer gateway.
 
- account
Id String - The account ID of the customer gateway.
 - connection
Count Integer - The connection count of the customer gateway.
 - creation
Time String - The create time of customer gateway.
 - customer
Gateway StringId  - The ID of the customer gateway.
 - customer
Gateway StringName  - The name of the customer gateway.
 - description String
 - The description of the customer gateway.
 - id String
 - The ID of the customer gateway.
 - ip
Address String - A IP address of the customer gateway.
 - status String
 - The status of the customer gateway.
 - update
Time String - The update time of customer gateway.
 
- account
Id string - The account ID of the customer gateway.
 - connection
Count number - The connection count of the customer gateway.
 - creation
Time string - The create time of customer gateway.
 - customer
Gateway stringId  - The ID of the customer gateway.
 - customer
Gateway stringName  - The name of the customer gateway.
 - description string
 - The description of the customer gateway.
 - id string
 - The ID of the customer gateway.
 - ip
Address string - A IP address of the customer gateway.
 - status string
 - The status of the customer gateway.
 - update
Time 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_ strid  - The ID of the customer gateway.
 - customer_
gateway_ strname  - 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.
 - status str
 - The status of the customer gateway.
 - update_
time str - The update time of customer gateway.
 
- account
Id String - The account ID of the customer gateway.
 - connection
Count Number - The connection count of the customer gateway.
 - creation
Time String - The create time of customer gateway.
 - customer
Gateway StringId  - The ID of the customer gateway.
 - customer
Gateway StringName  - The name of the customer gateway.
 - description String
 - The description of the customer gateway.
 - id String
 - The ID of the customer gateway.
 - ip
Address String - A IP address of the customer gateway.
 - status String
 - The status of the customer gateway.
 - update
Time String - The update time of customer gateway.
 
Package Details
- Repository
 - volcengine volcengine/pulumi-volcengine
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
volcengineTerraform Provider.