Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.19.0 published on Friday, Mar 18, 2022 by Pulumi

getCustomerGateways

The VPN customers gateways data source lists a number of VPN customer gateways resource information owned by an Alicloud account.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(AliCloud.Vpn.GetCustomerGateways.InvokeAsync(new AliCloud.Vpn.GetCustomerGatewaysArgs
        {
            Ids = 
            {
                "fake-id1",
                "fake-id2",
            },
            NameRegex = "testAcc*",
            OutputFile = "/tmp/cgws",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.GetCustomerGateways(ctx, &vpn.GetCustomerGatewaysArgs{
			Ids: []string{
				"fake-id1",
				"fake-id2",
			},
			NameRegex:  pulumi.StringRef("testAcc*"),
			OutputFile: pulumi.StringRef("/tmp/cgws"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

foo = alicloud.vpn.get_customer_gateways(ids=[
        "fake-id1",
        "fake-id2",
    ],
    name_regex="testAcc*",
    output_file="/tmp/cgws")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const foo = pulumi.output(alicloud.vpn.getCustomerGateways({
    ids: [
        "fake-id1",
        "fake-id2",
    ],
    nameRegex: "testAcc*",
    outputFile: "/tmp/cgws",
}));

Coming soon!

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(ids: Optional[Sequence[str]] = None,
                          name_regex: Optional[str] = None,
                          output_file: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCustomerGatewaysResult
def get_customer_gateways_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          name_regex: Optional[pulumi.Input[str]] = None,
                          output_file: Optional[pulumi.Input[str]] = 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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:vpn/getCustomerGateways:getCustomerGateways
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Ids List<string>

ID of the VPN customer gateways.

NameRegex string

A regex string of VPN customer gateways name.

OutputFile string

Save the result to the file.

Ids []string

ID of the VPN customer gateways.

NameRegex string

A regex string of VPN customer gateways name.

OutputFile string

Save the result to the file.

ids List

ID of the VPN customer gateways.

nameRegex String

A regex string of VPN customer gateways name.

outputFile String

Save the result to the file.

ids string[]

ID of the VPN customer gateways.

nameRegex string

A regex string of VPN customer gateways name.

outputFile string

Save the result to the file.

ids Sequence[str]

ID of the VPN customer gateways.

name_regex str

A regex string of VPN customer gateways name.

output_file str

Save the result to the file.

ids List

ID of the VPN customer gateways.

nameRegex String

A regex string of VPN customer gateways name.

outputFile String

Save the result to the file.

getCustomerGateways Result

The following output properties are available:

Gateways List<Pulumi.AliCloud.Vpn.Outputs.GetCustomerGatewaysGateway>

A list of VPN customer gateways. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>
Names List<string>
NameRegex string
OutputFile string
Gateways []GetCustomerGatewaysGateway

A list of VPN customer gateways. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Ids []string
Names []string
NameRegex string
OutputFile string
gateways ListCustomerGatewaysGateway>

A list of VPN customer gateways. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List
names List
nameRegex String
outputFile String
gateways GetCustomerGatewaysGateway[]

A list of VPN customer gateways. Each element contains the following attributes:

id string

The provider-assigned unique ID for this managed resource.

ids string[]
names string[]
nameRegex string
outputFile string
gateways Sequence[GetCustomerGatewaysGateway]

A list of VPN customer gateways. Each element contains the following attributes:

id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]
names Sequence[str]
name_regex str
output_file str
gateways List

A list of VPN customer gateways. Each element contains the following attributes:

id String

The provider-assigned unique ID for this managed resource.

ids List
names List
nameRegex String
outputFile String

Supporting Types

GetCustomerGatewaysGateway

CreateTime string

The creation time of the VPN customer gateway.

Description string

The description of the VPN customer gateway.

Id string

ID of the VPN customer gateway .

IpAddress string

The ip address of the VPN customer gateway.

Name string

The name of the VPN customer gateway.

CreateTime string

The creation time of the VPN customer gateway.

Description string

The description of the VPN customer gateway.

Id string

ID of the VPN customer gateway .

IpAddress string

The ip address of the VPN customer gateway.

Name string

The name of the VPN customer gateway.

createTime String

The creation time of the VPN customer gateway.

description String

The description of the VPN customer gateway.

id String

ID of the VPN customer gateway .

ipAddress String

The ip address of the VPN customer gateway.

name String

The name of the VPN customer gateway.

createTime string

The creation time of the VPN customer gateway.

description string

The description of the VPN customer gateway.

id string

ID of the VPN customer gateway .

ipAddress string

The ip address of the VPN customer gateway.

name string

The name of the VPN customer gateway.

create_time str

The creation time of the VPN customer gateway.

description str

The description of the VPN customer gateway.

id str

ID of the VPN customer gateway .

ip_address str

The ip address of the VPN customer gateway.

name str

The name of the VPN customer gateway.

createTime String

The creation time of the VPN customer gateway.

description String

The description of the VPN customer gateway.

id String

ID of the VPN customer gateway .

ipAddress String

The ip address of the VPN customer gateway.

name String

The name of the VPN customer gateway.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.