GetGateways

The VPNs data source lists a number of VPNs resource information owned by an Alicloud account.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var vpnGateways = Output.Create(AliCloud.Vpn.GetGateways.InvokeAsync(new AliCloud.Vpn.GetGatewaysArgs
        {
            BusinessStatus = "Normal",
            Ids = 
            {
                "fake-vpn-id1",
                "fake-vpn-id2",
            },
            NameRegex = "testAcc*",
            OutputFile = "/tmp/vpns",
            Status = "active",
            VpcId = "fake-vpc-id",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

vpn_gateways = alicloud.vpn.get_gateways(business_status="Normal",
    ids=[
        "fake-vpn-id1",
        "fake-vpn-id2",
    ],
    name_regex="testAcc*",
    output_file="/tmp/vpns",
    status="active",
    vpc_id="fake-vpc-id")

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

const vpnGateways = pulumi.output(alicloud.vpn.getGateways({
    businessStatus: "Normal",
    ids: [
        "fake-vpn-id1",
        "fake-vpn-id2",
    ],
    nameRegex: "testAcc*",
    outputFile: "/tmp/vpns",
    status: "active",
    vpcId: "fake-vpc-id",
}, { async: true }));

Using GetGateways

function getGateways(args: GetGatewaysArgs, opts?: InvokeOptions): Promise<GetGatewaysResult>

function  get_gateways(business_status=None, ids=None, name_regex=None, output_file=None, status=None, vpc_id=None, opts=None)

func GetGateways(ctx *Context, args *GetGatewaysArgs, opts ...InvokeOption) (*GetGatewaysResult, error)

public static class GetGateways {
    public static Task<GetGatewaysResult> InvokeAsync(GetGatewaysArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

BusinessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
Ids List<string>: IDs of the VPN.
NameRegex string: A regex string of VPN name.
OutputFile string: Save the result to the file.
Status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
VpcId string: Use the VPC ID as the search key.

BusinessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
Ids []string: IDs of the VPN.
NameRegex string: A regex string of VPN name.
OutputFile string: Save the result to the file.
Status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
VpcId string: Use the VPC ID as the search key.

businessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
ids string[]: IDs of the VPN.
nameRegex string: A regex string of VPN name.
outputFile string: Save the result to the file.
status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
vpcId string: Use the VPC ID as the search key.

business_status str: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
ids List[str]: IDs of the VPN.
name_regex str: A regex string of VPN name.
output_file str: Save the result to the file.
status str: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
vpc_id str: Use the VPC ID as the search key.

GetGateways Result

The following output properties are available:

Gateways List<Pulumi.AliCloud.Vpn.Outputs.GetGatewaysGateway>: A list of VPN gateways. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: IDs of the VPN.
Names List<string>: names of the VPN.
BusinessStatus string: The business status of the VPN gateway.
NameRegex string
OutputFile string
Status string: The status of the VPN
VpcId string: ID of the VPC that the VPN belongs.

Gateways []GetGatewaysGateway: A list of VPN gateways. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids []string: IDs of the VPN.
Names []string: names of the VPN.
BusinessStatus string: The business status of the VPN gateway.
NameRegex string
OutputFile string
Status string: The status of the VPN
VpcId string: ID of the VPC that the VPN belongs.

gateways GetGatewaysGateway[]: A list of VPN gateways. Each element contains the following attributes:
id string: The provider-assigned unique ID for this managed resource.
ids string[]: IDs of the VPN.
names string[]: names of the VPN.
businessStatus string: The business status of the VPN gateway.
nameRegex string
outputFile string
status string: The status of the VPN
vpcId string: ID of the VPC that the VPN belongs.

gateways List[GetGatewaysGateway]: A list of VPN gateways. Each element contains the following attributes:
id str: The provider-assigned unique ID for this managed resource.
ids List[str]: IDs of the VPN.
names List[str]: names of the VPN.
business_status str: The business status of the VPN gateway.
name_regex str
output_file str
status str: The status of the VPN
vpc_id str: ID of the VPC that the VPN belongs.

Supporting Types

GetGatewaysGateway

See the output API doc for this type.

BusinessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
CreateTime string: The creation time of the VPN gateway.
Description string: The description of the VPN
EnableIpsec string: Whether the ipsec function is enabled.
EnableSsl string: Whether the ssl function is enabled.
EndTime string: The expiration time of the VPN gateway.
Id string: ID of the VPN.
InstanceChargeType string: The charge type of the VPN gateway.
InternetIp string: The internet ip of the VPN.
Name string: The name of the VPN.
Specification string: The Specification of the VPN
SslConnections int: Total count of ssl vpn connections.
Status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
VpcId string: Use the VPC ID as the search key.

BusinessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
CreateTime string: The creation time of the VPN gateway.
Description string: The description of the VPN
EnableIpsec string: Whether the ipsec function is enabled.
EnableSsl string: Whether the ssl function is enabled.
EndTime string: The expiration time of the VPN gateway.
Id string: ID of the VPN.
InstanceChargeType string: The charge type of the VPN gateway.
InternetIp string: The internet ip of the VPN.
Name string: The name of the VPN.
Specification string: The Specification of the VPN
SslConnections int: Total count of ssl vpn connections.
Status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
VpcId string: Use the VPC ID as the search key.

businessStatus string: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
createTime string: The creation time of the VPN gateway.
description string: The description of the VPN
enableIpsec string: Whether the ipsec function is enabled.
enableSsl string: Whether the ssl function is enabled.
endTime string: The expiration time of the VPN gateway.
id string: ID of the VPN.
instanceChargeType string: The charge type of the VPN gateway.
internetIp string: The internet ip of the VPN.
name string: The name of the VPN.
specification string: The Specification of the VPN
sslConnections number: Total count of ssl vpn connections.
status string: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
vpcId string: Use the VPC ID as the search key.

business_status str: Limit search to specific business status - valid value is “Normal”, “FinancialLocked”.
create_time str: The creation time of the VPN gateway.
description str: The description of the VPN
enable_ipsec str: Whether the ipsec function is enabled.
enable_ssl str: Whether the ssl function is enabled.
end_time str: The expiration time of the VPN gateway.
id str: ID of the VPN.
instance_charge_type str: The charge type of the VPN gateway.
internet_ip str: The internet ip of the VPN.
name str: The name of the VPN.
specification str: The Specification of the VPN
ssl_connections float: Total count of ssl vpn connections.
status str: Limit search to specific status - valid value is “Init”, “Provisioning”, “Active”, “Updating”, “Deleting”.
vpc_id str: Use the VPC ID as the search key.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetGateways

Example Usage

Using GetGateways

GetGateways Result

Supporting Types

GetGatewaysGateway

Package Details

On This Page