1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. getVpnWireguardGateway
ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionoscloud.getVpnWireguardGateway

Explore with Pulumi AI

The ionoscloud.VpnWireguardGateway data source provides information about a specific IonosCloud VPN WireGuard Gateway. You can use this data source to retrieve details of a WireGuard Gateway for use in other resources and configurations.

Example Usage

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

const example = ionoscloud.getVpnWireguardGateway({
    location: "de/fra",
    name: "example-gateway",
});
export const vpnWireguardGatewayPublicKey = data.vpn_wireguard_gateway.example.public_key;
Copy
import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.get_vpn_wireguard_gateway(location="de/fra",
    name="example-gateway")
pulumi.export("vpnWireguardGatewayPublicKey", data["vpn_wireguard_gateway"]["example"]["public_key"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ionoscloud/v6/ionoscloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ionoscloud.LookupVpnWireguardGateway(ctx, &ionoscloud.LookupVpnWireguardGatewayArgs{
			Location: pulumi.StringRef("de/fra"),
			Name:     pulumi.StringRef("example-gateway"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpnWireguardGatewayPublicKey", data.Vpn_wireguard_gateway.Example.Public_key)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Pulumi.Ionoscloud;

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.GetVpnWireguardGateway.Invoke(new()
    {
        Location = "de/fra",
        Name = "example-gateway",
    });

    return new Dictionary<string, object?>
    {
        ["vpnWireguardGatewayPublicKey"] = data.Vpn_wireguard_gateway.Example.Public_key,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.IonoscloudFunctions;
import com.pulumi.ionoscloud.inputs.GetVpnWireguardGatewayArgs;
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) {
        final var example = IonoscloudFunctions.getVpnWireguardGateway(GetVpnWireguardGatewayArgs.builder()
            .location("de/fra")
            .name("example-gateway")
            .build());

        ctx.export("vpnWireguardGatewayPublicKey", data.vpn_wireguard_gateway().example().public_key());
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ionoscloud:getVpnWireguardGateway
      arguments:
        location: de/fra
        name: example-gateway
outputs:
  vpnWireguardGatewayPublicKey: ${data.vpn_wireguard_gateway.example.public_key}
Copy

Using getVpnWireguardGateway

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 getVpnWireguardGateway(args: GetVpnWireguardGatewayArgs, opts?: InvokeOptions): Promise<GetVpnWireguardGatewayResult>
function getVpnWireguardGatewayOutput(args: GetVpnWireguardGatewayOutputArgs, opts?: InvokeOptions): Output<GetVpnWireguardGatewayResult>
Copy
def get_vpn_wireguard_gateway(description: Optional[str] = None,
                              id: Optional[str] = None,
                              location: Optional[str] = None,
                              name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetVpnWireguardGatewayResult
def get_vpn_wireguard_gateway_output(description: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              location: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetVpnWireguardGatewayResult]
Copy
func LookupVpnWireguardGateway(ctx *Context, args *LookupVpnWireguardGatewayArgs, opts ...InvokeOption) (*LookupVpnWireguardGatewayResult, error)
func LookupVpnWireguardGatewayOutput(ctx *Context, args *LookupVpnWireguardGatewayOutputArgs, opts ...InvokeOption) LookupVpnWireguardGatewayResultOutput
Copy

> Note: This function is named LookupVpnWireguardGateway in the Go SDK.

public static class GetVpnWireguardGateway 
{
    public static Task<GetVpnWireguardGatewayResult> InvokeAsync(GetVpnWireguardGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnWireguardGatewayResult> Invoke(GetVpnWireguardGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVpnWireguardGatewayResult> getVpnWireguardGateway(GetVpnWireguardGatewayArgs args, InvokeOptions options)
public static Output<GetVpnWireguardGatewayResult> getVpnWireguardGateway(GetVpnWireguardGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ionoscloud:index/getVpnWireguardGateway:getVpnWireguardGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Description string
The description of the WireGuard Gateway.
Id string
[String] The ID of the WireGuard Gateway.
Location string
[String] The location of the WireGuard Gateway.
Name string
[String] The name of the WireGuard Gateway.
Description string
The description of the WireGuard Gateway.
Id string
[String] The ID of the WireGuard Gateway.
Location string
[String] The location of the WireGuard Gateway.
Name string
[String] The name of the WireGuard Gateway.
description String
The description of the WireGuard Gateway.
id String
[String] The ID of the WireGuard Gateway.
location String
[String] The location of the WireGuard Gateway.
name String
[String] The name of the WireGuard Gateway.
description string
The description of the WireGuard Gateway.
id string
[String] The ID of the WireGuard Gateway.
location string
[String] The location of the WireGuard Gateway.
name string
[String] The name of the WireGuard Gateway.
description str
The description of the WireGuard Gateway.
id str
[String] The ID of the WireGuard Gateway.
location str
[String] The location of the WireGuard Gateway.
name str
[String] The name of the WireGuard Gateway.
description String
The description of the WireGuard Gateway.
id String
[String] The ID of the WireGuard Gateway.
location String
[String] The location of the WireGuard Gateway.
name String
[String] The name of the WireGuard Gateway.

getVpnWireguardGateway Result

The following output properties are available:

Connections List<GetVpnWireguardGatewayConnection>
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
GatewayIp string
The IP address of the WireGuard Gateway.
Id string
InterfaceIpv4Cidr string
The IPv4 CIDR for the WireGuard Gateway interface.
InterfaceIpv6Cidr string
The IPv6 CIDR for the WireGuard Gateway interface.
ListenPort double
MaintenanceWindows List<GetVpnWireguardGatewayMaintenanceWindow>
A weekly 4 hour-long window, during which maintenance might occur.
Name string
PublicKey string
The public key for the WireGuard Gateway.
Status string
The current status of the WireGuard Gateway.
Tier string
Gateway performance options.
Description string
The description of the WireGuard Gateway.
Location string
Connections []GetVpnWireguardGatewayConnection
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
GatewayIp string
The IP address of the WireGuard Gateway.
Id string
InterfaceIpv4Cidr string
The IPv4 CIDR for the WireGuard Gateway interface.
InterfaceIpv6Cidr string
The IPv6 CIDR for the WireGuard Gateway interface.
ListenPort float64
MaintenanceWindows []GetVpnWireguardGatewayMaintenanceWindow
A weekly 4 hour-long window, during which maintenance might occur.
Name string
PublicKey string
The public key for the WireGuard Gateway.
Status string
The current status of the WireGuard Gateway.
Tier string
Gateway performance options.
Description string
The description of the WireGuard Gateway.
Location string
connections List<GetVpnWireguardGatewayConnection>
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
gatewayIp String
The IP address of the WireGuard Gateway.
id String
interfaceIpv4Cidr String
The IPv4 CIDR for the WireGuard Gateway interface.
interfaceIpv6Cidr String
The IPv6 CIDR for the WireGuard Gateway interface.
listenPort Double
maintenanceWindows List<GetVpnWireguardGatewayMaintenanceWindow>
A weekly 4 hour-long window, during which maintenance might occur.
name String
publicKey String
The public key for the WireGuard Gateway.
status String
The current status of the WireGuard Gateway.
tier String
Gateway performance options.
description String
The description of the WireGuard Gateway.
location String
connections GetVpnWireguardGatewayConnection[]
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
gatewayIp string
The IP address of the WireGuard Gateway.
id string
interfaceIpv4Cidr string
The IPv4 CIDR for the WireGuard Gateway interface.
interfaceIpv6Cidr string
The IPv6 CIDR for the WireGuard Gateway interface.
listenPort number
maintenanceWindows GetVpnWireguardGatewayMaintenanceWindow[]
A weekly 4 hour-long window, during which maintenance might occur.
name string
publicKey string
The public key for the WireGuard Gateway.
status string
The current status of the WireGuard Gateway.
tier string
Gateway performance options.
description string
The description of the WireGuard Gateway.
location string
connections Sequence[GetVpnWireguardGatewayConnection]
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
gateway_ip str
The IP address of the WireGuard Gateway.
id str
interface_ipv4_cidr str
The IPv4 CIDR for the WireGuard Gateway interface.
interface_ipv6_cidr str
The IPv6 CIDR for the WireGuard Gateway interface.
listen_port float
maintenance_windows Sequence[GetVpnWireguardGatewayMaintenanceWindow]
A weekly 4 hour-long window, during which maintenance might occur.
name str
public_key str
The public key for the WireGuard Gateway.
status str
The current status of the WireGuard Gateway.
tier str
Gateway performance options.
description str
The description of the WireGuard Gateway.
location str
connections List<Property Map>
A list of connection configurations for the WireGuard Gateway. Each connections block contains:
gatewayIp String
The IP address of the WireGuard Gateway.
id String
interfaceIpv4Cidr String
The IPv4 CIDR for the WireGuard Gateway interface.
interfaceIpv6Cidr String
The IPv6 CIDR for the WireGuard Gateway interface.
listenPort Number
maintenanceWindows List<Property Map>
A weekly 4 hour-long window, during which maintenance might occur.
name String
publicKey String
The public key for the WireGuard Gateway.
status String
The current status of the WireGuard Gateway.
tier String
Gateway performance options.
description String
The description of the WireGuard Gateway.
location String

Supporting Types

GetVpnWireguardGatewayConnection

DatacenterId This property is required. string
The ID of the datacenter where the WireGuard Gateway is located.
Ipv4Cidr This property is required. string
The IPv4 CIDR for the WireGuard Gateway connection.
Ipv6Cidr This property is required. string
The IPv6 CIDR for the WireGuard Gateway connection.
LanId This property is required. string
The ID of the LAN where the WireGuard Gateway is connected.
DatacenterId This property is required. string
The ID of the datacenter where the WireGuard Gateway is located.
Ipv4Cidr This property is required. string
The IPv4 CIDR for the WireGuard Gateway connection.
Ipv6Cidr This property is required. string
The IPv6 CIDR for the WireGuard Gateway connection.
LanId This property is required. string
The ID of the LAN where the WireGuard Gateway is connected.
datacenterId This property is required. String
The ID of the datacenter where the WireGuard Gateway is located.
ipv4Cidr This property is required. String
The IPv4 CIDR for the WireGuard Gateway connection.
ipv6Cidr This property is required. String
The IPv6 CIDR for the WireGuard Gateway connection.
lanId This property is required. String
The ID of the LAN where the WireGuard Gateway is connected.
datacenterId This property is required. string
The ID of the datacenter where the WireGuard Gateway is located.
ipv4Cidr This property is required. string
The IPv4 CIDR for the WireGuard Gateway connection.
ipv6Cidr This property is required. string
The IPv6 CIDR for the WireGuard Gateway connection.
lanId This property is required. string
The ID of the LAN where the WireGuard Gateway is connected.
datacenter_id This property is required. str
The ID of the datacenter where the WireGuard Gateway is located.
ipv4_cidr This property is required. str
The IPv4 CIDR for the WireGuard Gateway connection.
ipv6_cidr This property is required. str
The IPv6 CIDR for the WireGuard Gateway connection.
lan_id This property is required. str
The ID of the LAN where the WireGuard Gateway is connected.
datacenterId This property is required. String
The ID of the datacenter where the WireGuard Gateway is located.
ipv4Cidr This property is required. String
The IPv4 CIDR for the WireGuard Gateway connection.
ipv6Cidr This property is required. String
The IPv6 CIDR for the WireGuard Gateway connection.
lanId This property is required. String
The ID of the LAN where the WireGuard Gateway is connected.

GetVpnWireguardGatewayMaintenanceWindow

DayOfTheWeek This property is required. string
The name of the week day.
Time This property is required. string
Start of the maintenance window in UTC time.
DayOfTheWeek This property is required. string
The name of the week day.
Time This property is required. string
Start of the maintenance window in UTC time.
dayOfTheWeek This property is required. String
The name of the week day.
time This property is required. String
Start of the maintenance window in UTC time.
dayOfTheWeek This property is required. string
The name of the week day.
time This property is required. string
Start of the maintenance window in UTC time.
day_of_the_week This property is required. str
The name of the week day.
time This property is required. str
Start of the maintenance window in UTC time.
dayOfTheWeek This property is required. String
The name of the week day.
time This property is required. String
Start of the maintenance window in UTC time.

Package Details

Repository
ionoscloud ionos-cloud/terraform-provider-ionoscloud
License
Notes
This Pulumi package is based on the ionoscloud Terraform Provider.