GetConnections

The VPN connections data source lists lots of VPN connections 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.GetConnections.InvokeAsync(new AliCloud.Vpn.GetConnectionsArgs
        {
            CustomerGatewayId = "fake-cgw-id",
            Ids = 
            {
                "fake-conn-id",
            },
            OutputFile = "/tmp/vpnconn",
            VpnGatewayId = "fake-vpn-id",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

foo = alicloud.vpn.get_connections(customer_gateway_id="fake-cgw-id",
    ids=["fake-conn-id"],
    output_file="/tmp/vpnconn",
    vpn_gateway_id="fake-vpn-id")

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

const foo = pulumi.output(alicloud.vpn.getConnections({
    customerGatewayId: "fake-cgw-id",
    ids: ["fake-conn-id"],
    outputFile: "/tmp/vpnconn",
    vpnGatewayId: "fake-vpn-id",
}, { async: true }));

Using GetConnections

function getConnections(args: GetConnectionsArgs, opts?: InvokeOptions): Promise<GetConnectionsResult>

function  get_connections(customer_gateway_id=None, ids=None, name_regex=None, output_file=None, vpn_gateway_id=None, opts=None)

func GetConnections(ctx *Context, args *GetConnectionsArgs, opts ...InvokeOption) (*GetConnectionsResult, error)

public static class GetConnections {
    public static Task<GetConnectionsResult> InvokeAsync(GetConnectionsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

CustomerGatewayId string: Use the VPN customer gateway ID as the search key.
Ids List<string>: IDs of the VPN connections.
NameRegex string: A regex string of VPN connection name.
OutputFile string: Save the result to the file.
VpnGatewayId string: Use the VPN gateway ID as the search key.

CustomerGatewayId string: Use the VPN customer gateway ID as the search key.
Ids []string: IDs of the VPN connections.
NameRegex string: A regex string of VPN connection name.
OutputFile string: Save the result to the file.
VpnGatewayId string: Use the VPN gateway ID as the search key.

customerGatewayId string: Use the VPN customer gateway ID as the search key.
ids string[]: IDs of the VPN connections.
nameRegex string: A regex string of VPN connection name.
outputFile string: Save the result to the file.
vpnGatewayId string: Use the VPN gateway ID as the search key.

customer_gateway_id str: Use the VPN customer gateway ID as the search key.
ids List[str]: IDs of the VPN connections.
name_regex str: A regex string of VPN connection name.
output_file str: Save the result to the file.
vpn_gateway_id str: Use the VPN gateway ID as the search key.

GetConnections Result

The following output properties are available:

Connections List<Pulumi.AliCloud.Vpn.Outputs.GetConnectionsConnection>: A list of VPN connections. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: (Optional) IDs of the VPN connections.
Names List<string>: (Optional) names of the VPN connections.
CustomerGatewayId string: ID of the VPN customer gateway.
NameRegex string
OutputFile string
VpnGatewayId string: ID of the VPN gateway.

Connections []GetConnectionsConnection: A list of VPN connections. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids []string: (Optional) IDs of the VPN connections.
Names []string: (Optional) names of the VPN connections.
CustomerGatewayId string: ID of the VPN customer gateway.
NameRegex string
OutputFile string
VpnGatewayId string: ID of the VPN gateway.

connections GetConnectionsConnection[]: A list of VPN connections. Each element contains the following attributes:
id string: The provider-assigned unique ID for this managed resource.
ids string[]: (Optional) IDs of the VPN connections.
names string[]: (Optional) names of the VPN connections.
customerGatewayId string: ID of the VPN customer gateway.
nameRegex string
outputFile string
vpnGatewayId string: ID of the VPN gateway.

connections List[GetConnectionsConnection]: A list of VPN connections. Each element contains the following attributes:
id str: The provider-assigned unique ID for this managed resource.
ids List[str]: (Optional) IDs of the VPN connections.
names List[str]: (Optional) names of the VPN connections.
customer_gateway_id str: ID of the VPN customer gateway.
name_regex str
output_file str
vpn_gateway_id str: ID of the VPN gateway.

Supporting Types

GetConnectionsConnection

See the output API doc for this type.

CreateTime string
CustomerGatewayId string: Use the VPN customer gateway ID as the search key.
EffectImmediately bool
Id string: ID of the VPN connection.
LocalSubnet string: The local subnet of the VPN connection.
Name string: The name of the VPN connection.
RemoteSubnet string: The remote subnet of the VPN connection.
Status string: The status of the VPN connection, valid value:ike_sa_not_established, ike_sa_established, ipsec_sa_not_established, ipsec_sa_established.
VpnGatewayId string: Use the VPN gateway ID as the search key.
IkeConfigs List<Pulumi.AliCloud.Vpn.Inputs.GetConnectionsConnectionIkeConfigArgs>: The configurations of phase-one negotiation.
IpsecConfigs List<Pulumi.AliCloud.Vpn.Inputs.GetConnectionsConnectionIpsecConfigArgs>: The configurations of phase-two negotiation.

CreateTime string
CustomerGatewayId string: Use the VPN customer gateway ID as the search key.
EffectImmediately bool
Id string: ID of the VPN connection.
LocalSubnet string: The local subnet of the VPN connection.
Name string: The name of the VPN connection.
RemoteSubnet string: The remote subnet of the VPN connection.
Status string: The status of the VPN connection, valid value:ike_sa_not_established, ike_sa_established, ipsec_sa_not_established, ipsec_sa_established.
VpnGatewayId string: Use the VPN gateway ID as the search key.
IkeConfigs []GetConnectionsConnectionIkeConfig: The configurations of phase-one negotiation.
IpsecConfigs []GetConnectionsConnectionIpsecConfig: The configurations of phase-two negotiation.

createTime string
customerGatewayId string: Use the VPN customer gateway ID as the search key.
effectImmediately boolean
id string: ID of the VPN connection.
localSubnet string: The local subnet of the VPN connection.
name string: The name of the VPN connection.
remoteSubnet string: The remote subnet of the VPN connection.
status string: The status of the VPN connection, valid value:ike_sa_not_established, ike_sa_established, ipsec_sa_not_established, ipsec_sa_established.
vpnGatewayId string: Use the VPN gateway ID as the search key.
ikeConfigs GetConnectionsConnectionIkeConfig[]: The configurations of phase-one negotiation.
ipsecConfigs GetConnectionsConnectionIpsecConfig[]: The configurations of phase-two negotiation.

create_time str
customer_gateway_id str: Use the VPN customer gateway ID as the search key.
effect_immediately bool
id str: ID of the VPN connection.
local_subnet str: The local subnet of the VPN connection.
name str: The name of the VPN connection.
remoteSubnet str: The remote subnet of the VPN connection.
status str: The status of the VPN connection, valid value:ike_sa_not_established, ike_sa_established, ipsec_sa_not_established, ipsec_sa_established.
vpn_gateway_id str: Use the VPN gateway ID as the search key.
ike_configs List[GetConnectionsConnectionIkeConfig]: The configurations of phase-one negotiation.
ipsec_configs List[GetConnectionsConnectionIpsecConfig]: The configurations of phase-two negotiation.

GetConnectionsConnectionIkeConfig

See the output API doc for this type.

IkeAuthAlg string: The authentication algorithm of phase-one negotiation.
IkeEncAlg string: The encryption algorithm of phase-one negotiation.
IkeLifetime int: The SA lifecycle as the result of phase-one negotiation.
IkeLocalId string: The identification of the VPN gateway.
IkeMode string: The negotiation mode of IKE phase-one.
IkePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation.
IkeRemoteId string: The identification of the customer gateway.
IkeVersion string: The version of the IKE protocol.
Psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

IkeAuthAlg string: The authentication algorithm of phase-one negotiation.
IkeEncAlg string: The encryption algorithm of phase-one negotiation.
IkeLifetime int: The SA lifecycle as the result of phase-one negotiation.
IkeLocalId string: The identification of the VPN gateway.
IkeMode string: The negotiation mode of IKE phase-one.
IkePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation.
IkeRemoteId string: The identification of the customer gateway.
IkeVersion string: The version of the IKE protocol.
Psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

ikeAuthAlg string: The authentication algorithm of phase-one negotiation.
ikeEncAlg string: The encryption algorithm of phase-one negotiation.
ikeLifetime number: The SA lifecycle as the result of phase-one negotiation.
ikeLocalId string: The identification of the VPN gateway.
ikeMode string: The negotiation mode of IKE phase-one.
ikePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation.
ikeRemoteId string: The identification of the customer gateway.
ikeVersion string: The version of the IKE protocol.
psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

ikeAuthAlg str: The authentication algorithm of phase-one negotiation.
ikeEncAlg str: The encryption algorithm of phase-one negotiation.
ikeLifetime float: The SA lifecycle as the result of phase-one negotiation.
ikeLocalId str: The identification of the VPN gateway.
ikeMode str: The negotiation mode of IKE phase-one.
ikePfs str: The Diffie-Hellman key exchange algorithm used by phase-one negotiation.
ikeRemoteId str: The identification of the customer gateway.
ikeVersion str: The version of the IKE protocol.
psk str: Used for authentication between the IPsec VPN gateway and the customer gateway.

GetConnectionsConnectionIpsecConfig

See the output API doc for this type.

IpsecAuthAlg string: The authentication algorithm of phase-two negotiation.
IpsecEncAlg string: The encryption algorithm of phase-two negotiation.
IpsecLifetime int: The SA lifecycle as the result of phase-two negotiation.
IpsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation.

IpsecAuthAlg string: The authentication algorithm of phase-two negotiation.
IpsecEncAlg string: The encryption algorithm of phase-two negotiation.
IpsecLifetime int: The SA lifecycle as the result of phase-two negotiation.
IpsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation.

ipsecAuthAlg string: The authentication algorithm of phase-two negotiation.
ipsecEncAlg string: The encryption algorithm of phase-two negotiation.
ipsecLifetime number: The SA lifecycle as the result of phase-two negotiation.
ipsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation.

ipsecAuthAlg str: The authentication algorithm of phase-two negotiation.
ipsecEncAlg str: The encryption algorithm of phase-two negotiation.
ipsecLifetime float: The SA lifecycle as the result of phase-two negotiation.
ipsecPfs str: The Diffie-Hellman key exchange algorithm used by phase-two negotiation.

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

GetConnections

Example Usage

Using GetConnections

GetConnections Result

Supporting Types

GetConnectionsConnection

GetConnectionsConnectionIkeConfig

GetConnectionsConnectionIpsecConfig

Package Details

On This Page