Docs Packages
  1. Packages
  2. Volcengine
  3. API Docs
  4. vpn
  5. CustomerGateways
Volcengine v0.0.18 published on Wednesday, Sep 13, 2023 by Volcengine
volcengine/pulumi-volcengine

volcengine.vpn.CustomerGateways

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.18 published on Wednesday, Sep 13, 2023 by Volcengine
volcengine/pulumi-volcengine

    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;
using Volcengine = 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) CustomerGatewaysResultOutput
    public 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 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.

    NameRegex string

    A Name Regex of customer gateway.

    OutputFile string

    File name where to save data source results.

    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.

    NameRegex string

    A Name Regex of customer gateway.

    OutputFile string

    File name where to save data source results.

    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.

    nameRegex String

    A Name Regex of customer gateway.

    outputFile String

    File name where to save data source results.

    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.

    nameRegex string

    A Name Regex of customer gateway.

    outputFile string

    File name where to save data source results.

    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.

    name_regex str

    A Name Regex of customer gateway.

    output_file str

    File name where to save data source results.

    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.

    nameRegex String

    A Name Regex of customer gateway.

    outputFile String

    File name where to save data source results.

    CustomerGateways Result

    The following output properties are available:

    CustomerGateways List<Volcengine.CustomerGatewaysCustomerGateway>

    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.

    NameRegex string
    OutputFile string
    CustomerGateways []CustomerGatewaysCustomerGateway

    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.

    NameRegex string
    OutputFile string
    customerGateways List<CustomerGatewaysCustomerGateway>

    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.

    nameRegex String
    outputFile String
    customerGateways CustomerGatewaysCustomerGateway[]

    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.

    nameRegex string
    outputFile string
    customer_gateways Sequence[CustomerGatewaysCustomerGateway]

    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.

    name_regex str
    output_file str
    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.

    nameRegex String
    outputFile String

    Supporting Types

    CustomerGatewaysCustomerGateway

    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.

    Status string

    The status of the customer gateway.

    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.

    Status string

    The status of the customer gateway.

    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.

    status String

    The status of the customer gateway.

    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.

    status string

    The status of the customer gateway.

    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.

    status str

    The status of the customer gateway.

    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.

    status String

    The status of the customer gateway.

    updateTime 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 volcengine Terraform Provider.

    volcengine logo
    Volcengine v0.0.18 published on Wednesday, Sep 13, 2023 by Volcengine
    volcengine/pulumi-volcengine