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

scaleway.s2svpn.getCustomerGateway

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.getCustomerGateway({
    customerGatewayId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_scaleway as scaleway

# Get info by gateway ID
my_gateway = scaleway.s2svpn.get_customer_gateway(customer_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.LookupCustomerGateway(ctx, &s2svpn.LookupCustomerGatewayArgs{
			CustomerGatewayId: 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.GetCustomerGateway.Invoke(new()
    {
        CustomerGatewayId = "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.GetCustomerGatewayArgs;
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.getCustomerGateway(GetCustomerGatewayArgs.builder()
            .customerGatewayId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    variables:
  # Get info by gateway ID
  myGateway:
    fn::invoke:
      function: scaleway:s2svpn:getCustomerGateway
      arguments:
        customerGatewayId: 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.getCustomerGateway({
    name: "foobar",
});

    import pulumi
import pulumi_scaleway as scaleway

# Get info by name
my_gateway = scaleway.s2svpn.get_customer_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.LookupCustomerGateway(ctx, &s2svpn.LookupCustomerGatewayArgs{
			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.GetCustomerGateway.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.GetCustomerGatewayArgs;
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.getCustomerGateway(GetCustomerGatewayArgs.builder()
            .name("foobar")
            .build());

    }
}

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

    Using getCustomerGateway

    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 getCustomerGateway(args: GetCustomerGatewayArgs, opts?: InvokeOptions): Promise<GetCustomerGatewayResult>
function getCustomerGatewayOutput(args: GetCustomerGatewayOutputArgs, opts?: InvokeOptions): Output<GetCustomerGatewayResult>
    def get_customer_gateway(customer_gateway_id: Optional[str] = None,
                         name: Optional[str] = None,
                         project_id: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomerGatewayResult
def get_customer_gateway_output(customer_gateway_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         region: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomerGatewayResult]
    func LookupCustomerGateway(ctx *Context, args *LookupCustomerGatewayArgs, opts ...InvokeOption) (*LookupCustomerGatewayResult, error)
func LookupCustomerGatewayOutput(ctx *Context, args *LookupCustomerGatewayOutputArgs, opts ...InvokeOption) LookupCustomerGatewayResultOutput

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

    public static class GetCustomerGateway 
{
    public static Task<GetCustomerGatewayResult> InvokeAsync(GetCustomerGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomerGatewayResult> Invoke(GetCustomerGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)
public static Output<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CustomerGatewayId string

    The customer gateway ID.

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

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

    The customer gateway ID.

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

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

    The customer gateway ID.

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

    name String
    The name of the customer gateway.
    projectId String
    The ID of the project the customer gateway is associated with.
    region String
    region) The region in which the customer gateway exists.
    customerGatewayId string

    The customer gateway ID.

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

    name string
    The name of the customer gateway.
    projectId string
    The ID of the project the customer gateway is associated with.
    region string
    region) The region in which the customer gateway exists.
    customer_gateway_id str

    The customer gateway ID.

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

    name str
    The name of the customer gateway.
    project_id str
    The ID of the project the customer gateway is associated with.
    region str
    region) The region in which the customer gateway exists.
    customerGatewayId String

    The customer gateway ID.

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

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

    getCustomerGateway Result

    The following output properties are available:

    Asn int
    The AS Number of the customer gateway.
    CreatedAt string
    The date and time of creation of the customer gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4Public string
    The public IPv4 address of the customer gateway.
    Ipv6Public string
    The public IPv6 address of the customer gateway.
    OrganizationId string
    The Organization ID the customer gateway is associated with.
    Tags List<string>
    The tags associated with the customer gateway.
    UpdatedAt string
    The date and time of the last update of the customer gateway.
    CustomerGatewayId string
    Name string
    ProjectId string
    Region string
    Asn int
    The AS Number of the customer gateway.
    CreatedAt string
    The date and time of creation of the customer gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4Public string
    The public IPv4 address of the customer gateway.
    Ipv6Public string
    The public IPv6 address of the customer gateway.
    OrganizationId string
    The Organization ID the customer gateway is associated with.
    Tags []string
    The tags associated with the customer gateway.
    UpdatedAt string
    The date and time of the last update of the customer gateway.
    CustomerGatewayId string
    Name string
    ProjectId string
    Region string
    asn Integer
    The AS Number of the customer gateway.
    createdAt String
    The date and time of creation of the customer gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4Public String
    The public IPv4 address of the customer gateway.
    ipv6Public String
    The public IPv6 address of the customer gateway.
    organizationId String
    The Organization ID the customer gateway is associated with.
    tags List<String>
    The tags associated with the customer gateway.
    updatedAt String
    The date and time of the last update of the customer gateway.
    customerGatewayId String
    name String
    projectId String
    region String
    asn number
    The AS Number of the customer gateway.
    createdAt string
    The date and time of creation of the customer gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv4Public string
    The public IPv4 address of the customer gateway.
    ipv6Public string
    The public IPv6 address of the customer gateway.
    organizationId string
    The Organization ID the customer gateway is associated with.
    tags string[]
    The tags associated with the customer gateway.
    updatedAt string
    The date and time of the last update of the customer gateway.
    customerGatewayId string
    name string
    projectId string
    region string
    asn int
    The AS Number of the customer gateway.
    created_at str
    The date and time of creation of the customer gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv4_public str
    The public IPv4 address of the customer gateway.
    ipv6_public str
    The public IPv6 address of the customer gateway.
    organization_id str
    The Organization ID the customer gateway is associated with.
    tags Sequence[str]
    The tags associated with the customer gateway.
    updated_at str
    The date and time of the last update of the customer gateway.
    customer_gateway_id str
    name str
    project_id str
    region str
    asn Number
    The AS Number of the customer gateway.
    createdAt String
    The date and time of creation of the customer gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4Public String
    The public IPv4 address of the customer gateway.
    ipv6Public String
    The public IPv6 address of the customer gateway.
    organizationId String
    The Organization ID the customer gateway is associated with.
    tags List<String>
    The tags associated with the customer gateway.
    updatedAt String
    The date and time of the last update of the customer gateway.
    customerGatewayId String
    name String
    projectId String
    region String

    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.