1. Packages
  2. Scaleway
  3. API Docs
  4. s2svpn
  5. getGateway
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.s2svpn.getGateway

scaleway logo
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    For further information refer to the Site-to-Site VPN API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Get info by gateway ID
const myGateway = scaleway.s2svpn.getGateway({
    vpnGatewayId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_scaleway as scaleway

# Get info by gateway ID
my_gateway = scaleway.s2svpn.get_gateway(vpn_gateway_id="11111111-1111-1111-1111-111111111111")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/s2svpn"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by gateway ID
		_, err := s2svpn.LookupGateway(ctx, &s2svpn.LookupGatewayArgs{
			VpnGatewayId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get info by gateway ID
    var myGateway = Scaleway.S2svpn.GetGateway.Invoke(new()
    {
        VpnGatewayId = "11111111-1111-1111-1111-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.s2svpn.S2svpnFunctions;
import com.pulumi.scaleway.s2svpn.inputs.GetGatewayArgs;
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) {
        // Get info by gateway ID
        final var myGateway = S2svpnFunctions.getGateway(GetGatewayArgs.builder()
            .vpnGatewayId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    variables:
  # Get info by gateway ID
  myGateway:
    fn::invoke:
      function: scaleway:s2svpn:getGateway
      arguments:
        vpnGatewayId: 11111111-1111-1111-1111-111111111111

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Get info by name
const myGateway = scaleway.s2svpn.getGateway({
    name: "foobar",
});

    import pulumi
import pulumi_scaleway as scaleway

# Get info by name
my_gateway = scaleway.s2svpn.get_gateway(name="foobar")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/s2svpn"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by name
		_, err := s2svpn.LookupGateway(ctx, &s2svpn.LookupGatewayArgs{
			Name: pulumi.StringRef("foobar"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get info by name
    var myGateway = Scaleway.S2svpn.GetGateway.Invoke(new()
    {
        Name = "foobar",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.s2svpn.S2svpnFunctions;
import com.pulumi.scaleway.s2svpn.inputs.GetGatewayArgs;
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) {
        // Get info by name
        final var myGateway = S2svpnFunctions.getGateway(GetGatewayArgs.builder()
            .name("foobar")
            .build());

    }
}

    variables:
  # Get info by name
  myGateway:
    fn::invoke:
      function: scaleway:s2svpn:getGateway
      arguments:
        name: foobar

    Using getGateway

    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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
    def get_gateway(name: Optional[str] = None,
                project_id: Optional[str] = None,
                region: Optional[str] = None,
                vpn_gateway_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                vpn_gateway_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
    func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput

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

    public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: scaleway:s2svpn/getGateway:getGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the VPN gateway.
    ProjectId string
    The ID of the project the VPN gateway is associated with.
    Region string
    region) The region in which the VPN gateway exists.
    VpnGatewayId string

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    Name string
    The name of the VPN gateway.
    ProjectId string
    The ID of the project the VPN gateway is associated with.
    Region string
    region) The region in which the VPN gateway exists.
    VpnGatewayId string

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    name String
    The name of the VPN gateway.
    projectId String
    The ID of the project the VPN gateway is associated with.
    region String
    region) The region in which the VPN gateway exists.
    vpnGatewayId String

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    name string
    The name of the VPN gateway.
    projectId string
    The ID of the project the VPN gateway is associated with.
    region string
    region) The region in which the VPN gateway exists.
    vpnGatewayId string

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    name str
    The name of the VPN gateway.
    project_id str
    The ID of the project the VPN gateway is associated with.
    region str
    region) The region in which the VPN gateway exists.
    vpn_gateway_id str

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    name String
    The name of the VPN gateway.
    projectId String
    The ID of the project the VPN gateway is associated with.
    region String
    region) The region in which the VPN gateway exists.
    vpnGatewayId String

    The VPN gateway ID.

    Note You must specify at least one: name and/or vpn_gateway_id.

    getGateway Result

    The following output properties are available:

    Asn int
    The AS Number of the VPN gateway.
    CreatedAt string
    The date and time of creation of the VPN gateway.
    GatewayType string
    The VPN gateway type (commercial offer type).
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamPrivateIpv4Id string
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    IpamPrivateIpv6Id string
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    OrganizationId string
    The Organization ID the VPN gateway is associated with.
    PrivateNetworkId string
    The ID of the Private Network attached to the VPN gateway.
    PublicConfigs List<Pulumiverse.Scaleway.S2svpn.Outputs.GetGatewayPublicConfig>
    The public endpoint configuration of the VPN gateway.
    Status string
    The status of the VPN gateway.
    Tags List<string>
    The tags associated with the VPN gateway.
    UpdatedAt string
    The date and time of the last update of the VPN gateway.
    Zone string
    The zone in which the VPN gateway is deployed.
    Name string
    ProjectId string
    Region string
    VpnGatewayId string
    Asn int
    The AS Number of the VPN gateway.
    CreatedAt string
    The date and time of creation of the VPN gateway.
    GatewayType string
    The VPN gateway type (commercial offer type).
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamPrivateIpv4Id string
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    IpamPrivateIpv6Id string
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    OrganizationId string
    The Organization ID the VPN gateway is associated with.
    PrivateNetworkId string
    The ID of the Private Network attached to the VPN gateway.
    PublicConfigs []GetGatewayPublicConfig
    The public endpoint configuration of the VPN gateway.
    Status string
    The status of the VPN gateway.
    Tags []string
    The tags associated with the VPN gateway.
    UpdatedAt string
    The date and time of the last update of the VPN gateway.
    Zone string
    The zone in which the VPN gateway is deployed.
    Name string
    ProjectId string
    Region string
    VpnGatewayId string
    asn Integer
    The AS Number of the VPN gateway.
    createdAt String
    The date and time of creation of the VPN gateway.
    gatewayType String
    The VPN gateway type (commercial offer type).
    id String
    The provider-assigned unique ID for this managed resource.
    ipamPrivateIpv4Id String
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    ipamPrivateIpv6Id String
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    organizationId String
    The Organization ID the VPN gateway is associated with.
    privateNetworkId String
    The ID of the Private Network attached to the VPN gateway.
    publicConfigs List<GetGatewayPublicConfig>
    The public endpoint configuration of the VPN gateway.
    status String
    The status of the VPN gateway.
    tags List<String>
    The tags associated with the VPN gateway.
    updatedAt String
    The date and time of the last update of the VPN gateway.
    zone String
    The zone in which the VPN gateway is deployed.
    name String
    projectId String
    region String
    vpnGatewayId String
    asn number
    The AS Number of the VPN gateway.
    createdAt string
    The date and time of creation of the VPN gateway.
    gatewayType string
    The VPN gateway type (commercial offer type).
    id string
    The provider-assigned unique ID for this managed resource.
    ipamPrivateIpv4Id string
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    ipamPrivateIpv6Id string
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    organizationId string
    The Organization ID the VPN gateway is associated with.
    privateNetworkId string
    The ID of the Private Network attached to the VPN gateway.
    publicConfigs GetGatewayPublicConfig[]
    The public endpoint configuration of the VPN gateway.
    status string
    The status of the VPN gateway.
    tags string[]
    The tags associated with the VPN gateway.
    updatedAt string
    The date and time of the last update of the VPN gateway.
    zone string
    The zone in which the VPN gateway is deployed.
    name string
    projectId string
    region string
    vpnGatewayId string
    asn int
    The AS Number of the VPN gateway.
    created_at str
    The date and time of creation of the VPN gateway.
    gateway_type str
    The VPN gateway type (commercial offer type).
    id str
    The provider-assigned unique ID for this managed resource.
    ipam_private_ipv4_id str
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    ipam_private_ipv6_id str
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    organization_id str
    The Organization ID the VPN gateway is associated with.
    private_network_id str
    The ID of the Private Network attached to the VPN gateway.
    public_configs Sequence[GetGatewayPublicConfig]
    The public endpoint configuration of the VPN gateway.
    status str
    The status of the VPN gateway.
    tags Sequence[str]
    The tags associated with the VPN gateway.
    updated_at str
    The date and time of the last update of the VPN gateway.
    zone str
    The zone in which the VPN gateway is deployed.
    name str
    project_id str
    region str
    vpn_gateway_id str
    asn Number
    The AS Number of the VPN gateway.
    createdAt String
    The date and time of creation of the VPN gateway.
    gatewayType String
    The VPN gateway type (commercial offer type).
    id String
    The provider-assigned unique ID for this managed resource.
    ipamPrivateIpv4Id String
    The ID of the IPAM private IPv4 address attached to the VPN gateway.
    ipamPrivateIpv6Id String
    The ID of the IPAM private IPv6 address attached to the VPN gateway.
    organizationId String
    The Organization ID the VPN gateway is associated with.
    privateNetworkId String
    The ID of the Private Network attached to the VPN gateway.
    publicConfigs List<Property Map>
    The public endpoint configuration of the VPN gateway.
    status String
    The status of the VPN gateway.
    tags List<String>
    The tags associated with the VPN gateway.
    updatedAt String
    The date and time of the last update of the VPN gateway.
    zone String
    The zone in which the VPN gateway is deployed.
    name String
    projectId String
    region String
    vpnGatewayId String

    Supporting Types

    GetGatewayPublicConfig

    IpamIpv4Id string
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    IpamIpv6Id string
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway
    IpamIpv4Id string
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    IpamIpv6Id string
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway
    ipamIpv4Id String
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    ipamIpv6Id String
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway
    ipamIpv4Id string
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    ipamIpv6Id string
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway
    ipam_ipv4_id str
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    ipam_ipv6_id str
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway
    ipamIpv4Id String
    The ID of the IPAM IPv4 address to use as the public IP for the VPN gateway
    ipamIpv6Id String
    The ID of the IPAM IPv6 address to use as the public IP for the VPN gateway

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.44.1
    published on Monday, Mar 9, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway
      Try Pulumi Cloud free. Your team will thank you.