Scaleway v1.26.0, Mar 28 25

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.getVpcGatewayNetwork

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const main = new scaleway.network.GatewayNetwork("main", {
    gatewayId: pg01.id,
    privateNetworkId: pn01.id,
    dhcpId: dhcp01.id,
    cleanupDhcp: true,
    enableMasquerade: true,
});
const byId = scaleway.network.getGatewayNetworkOutput({
    gatewayNetworkId: main.id,
});
const byGatewayAndPn = scaleway.network.getGatewayNetwork({
    gatewayId: pg01.id,
    privateNetworkId: pn01.id,
});

import pulumi
import pulumi_scaleway as scaleway
import pulumiverse_scaleway as scaleway

main = scaleway.network.GatewayNetwork("main",
    gateway_id=pg01["id"],
    private_network_id=pn01["id"],
    dhcp_id=dhcp01["id"],
    cleanup_dhcp=True,
    enable_masquerade=True)
by_id = scaleway.network.get_gateway_network_output(gateway_network_id=main.id)
by_gateway_and_pn = scaleway.network.get_gateway_network(gateway_id=pg01["id"],
    private_network_id=pn01["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := network.NewGatewayNetwork(ctx, "main", &network.GatewayNetworkArgs{
			GatewayId:        pulumi.Any(pg01.Id),
			PrivateNetworkId: pulumi.Any(pn01.Id),
			DhcpId:           pulumi.Any(dhcp01.Id),
			CleanupDhcp:      pulumi.Bool(true),
			EnableMasquerade: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_ = network.LookupGatewayNetworkOutput(ctx, network.GetGatewayNetworkOutputArgs{
			GatewayNetworkId: main.ID(),
		}, nil)
		_, err = network.LookupGatewayNetwork(ctx, &network.LookupGatewayNetworkArgs{
			GatewayId:        pulumi.StringRef(pg01.Id),
			PrivateNetworkId: pulumi.StringRef(pn01.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var main = new Scaleway.Network.GatewayNetwork("main", new()
    {
        GatewayId = pg01.Id,
        PrivateNetworkId = pn01.Id,
        DhcpId = dhcp01.Id,
        CleanupDhcp = true,
        EnableMasquerade = true,
    });

    var byId = Scaleway.Network.GetGatewayNetwork.Invoke(new()
    {
        GatewayNetworkId = main.Id,
    });

    var byGatewayAndPn = Scaleway.Network.GetGatewayNetwork.Invoke(new()
    {
        GatewayId = pg01.Id,
        PrivateNetworkId = pn01.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.GatewayNetwork;
import com.pulumi.scaleway.network.GatewayNetworkArgs;
import com.pulumi.scaleway.network.NetworkFunctions;
import com.pulumi.scaleway.network.inputs.GetGatewayNetworkArgs;
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) {
        var main = new GatewayNetwork("main", GatewayNetworkArgs.builder()
            .gatewayId(pg01.id())
            .privateNetworkId(pn01.id())
            .dhcpId(dhcp01.id())
            .cleanupDhcp(true)
            .enableMasquerade(true)
            .build());

        final var byId = NetworkFunctions.getGatewayNetwork(GetGatewayNetworkArgs.builder()
            .gatewayNetworkId(main.id())
            .build());

        final var byGatewayAndPn = NetworkFunctions.getGatewayNetwork(GetGatewayNetworkArgs.builder()
            .gatewayId(pg01.id())
            .privateNetworkId(pn01.id())
            .build());

    }
}

resources:
  main:
    type: scaleway:network:GatewayNetwork
    properties:
      gatewayId: ${pg01.id}
      privateNetworkId: ${pn01.id}
      dhcpId: ${dhcp01.id}
      cleanupDhcp: true
      enableMasquerade: true
variables:
  byId:
    fn::invoke:
      function: scaleway:network:getGatewayNetwork
      arguments:
        gatewayNetworkId: ${main.id}
  byGatewayAndPn:
    fn::invoke:
      function: scaleway:network:getGatewayNetwork
      arguments:
        gatewayId: ${pg01.id}
        privateNetworkId: ${pn01.id}

Using getVpcGatewayNetwork

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.

TypeScript
Python
Go
C#
Java
YAML

function getVpcGatewayNetwork(args: GetVpcGatewayNetworkArgs, opts?: InvokeOptions): Promise<GetVpcGatewayNetworkResult>
function getVpcGatewayNetworkOutput(args: GetVpcGatewayNetworkOutputArgs, opts?: InvokeOptions): Output<GetVpcGatewayNetworkResult>

def get_vpc_gateway_network(dhcp_id: Optional[str] = None,
                            enable_masquerade: Optional[bool] = None,
                            gateway_id: Optional[str] = None,
                            gateway_network_id: Optional[str] = None,
                            private_network_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVpcGatewayNetworkResult
def get_vpc_gateway_network_output(dhcp_id: Optional[pulumi.Input[str]] = None,
                            enable_masquerade: Optional[pulumi.Input[bool]] = None,
                            gateway_id: Optional[pulumi.Input[str]] = None,
                            gateway_network_id: Optional[pulumi.Input[str]] = None,
                            private_network_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetVpcGatewayNetworkResult]

func LookupVpcGatewayNetwork(ctx *Context, args *LookupVpcGatewayNetworkArgs, opts ...InvokeOption) (*LookupVpcGatewayNetworkResult, error)
func LookupVpcGatewayNetworkOutput(ctx *Context, args *LookupVpcGatewayNetworkOutputArgs, opts ...InvokeOption) LookupVpcGatewayNetworkResultOutput

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

public static class GetVpcGatewayNetwork 
{
    public static Task<GetVpcGatewayNetworkResult> InvokeAsync(GetVpcGatewayNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcGatewayNetworkResult> Invoke(GetVpcGatewayNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpcGatewayNetworkResult> getVpcGatewayNetwork(GetVpcGatewayNetworkArgs args, InvokeOptions options)
public static Output<GetVpcGatewayNetworkResult> getVpcGatewayNetwork(GetVpcGatewayNetworkArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:index/getVpcGatewayNetwork:getVpcGatewayNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

DhcpId string
EnableMasquerade bool
GatewayId string
GatewayNetworkId string: ID of the GatewayNetwork.
PrivateNetworkId string

DhcpId string
EnableMasquerade bool
GatewayId string
GatewayNetworkId string: ID of the GatewayNetwork.
PrivateNetworkId string

dhcpId String
enableMasquerade Boolean
gatewayId String
gatewayNetworkId String: ID of the GatewayNetwork.
privateNetworkId String

dhcpId string
enableMasquerade boolean
gatewayId string
gatewayNetworkId string: ID of the GatewayNetwork.
privateNetworkId string

dhcp_id str
enable_masquerade bool
gateway_id str
gateway_network_id str: ID of the GatewayNetwork.
private_network_id str

dhcpId String
enableMasquerade Boolean
gatewayId String
gatewayNetworkId String: ID of the GatewayNetwork.
privateNetworkId String

getVpcGatewayNetwork Result

The following output properties are available:

CleanupDhcp bool
CreatedAt string
EnableDhcp bool
Id string: The provider-assigned unique ID for this managed resource.
IpamConfigs List<Pulumiverse.Scaleway.Outputs.GetVpcGatewayNetworkIpamConfig>
MacAddress string
StaticAddress string
Status string
UpdatedAt string
Zone string
DhcpId string
EnableMasquerade bool
GatewayId string
GatewayNetworkId string
PrivateNetworkId string

CleanupDhcp bool
CreatedAt string
EnableDhcp bool
Id string: The provider-assigned unique ID for this managed resource.
IpamConfigs []GetVpcGatewayNetworkIpamConfig
MacAddress string
StaticAddress string
Status string
UpdatedAt string
Zone string
DhcpId string
EnableMasquerade bool
GatewayId string
GatewayNetworkId string
PrivateNetworkId string

cleanupDhcp Boolean
createdAt String
enableDhcp Boolean
id String: The provider-assigned unique ID for this managed resource.
ipamConfigs List<GetVpcGatewayNetworkIpamConfig>
macAddress String
staticAddress String
status String
updatedAt String
zone String
dhcpId String
enableMasquerade Boolean
gatewayId String
gatewayNetworkId String
privateNetworkId String

cleanupDhcp boolean
createdAt string
enableDhcp boolean
id string: The provider-assigned unique ID for this managed resource.
ipamConfigs GetVpcGatewayNetworkIpamConfig[]
macAddress string
staticAddress string
status string
updatedAt string
zone string
dhcpId string
enableMasquerade boolean
gatewayId string
gatewayNetworkId string
privateNetworkId string

cleanup_dhcp bool
created_at str
enable_dhcp bool
id str: The provider-assigned unique ID for this managed resource.
ipam_configs Sequence[GetVpcGatewayNetworkIpamConfig]
mac_address str
static_address str
status str
updated_at str
zone str
dhcp_id str
enable_masquerade bool
gateway_id str
gateway_network_id str
private_network_id str

cleanupDhcp Boolean
createdAt String
enableDhcp Boolean
id String: The provider-assigned unique ID for this managed resource.
ipamConfigs List<Property Map>
macAddress String
staticAddress String
status String
updatedAt String
zone String
dhcpId String
enableMasquerade Boolean
gatewayId String
gatewayNetworkId String
privateNetworkId String

Supporting Types

GetVpcGatewayNetworkIpamConfig

IpamIpId string: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
PushDefaultRoute bool: Defines whether the default route is enabled on that Gateway Network

IpamIpId string: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
PushDefaultRoute bool: Defines whether the default route is enabled on that Gateway Network

ipamIpId String: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
pushDefaultRoute Boolean: Defines whether the default route is enabled on that Gateway Network

ipamIpId string: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
pushDefaultRoute boolean: Defines whether the default route is enabled on that Gateway Network

ipam_ip_id str: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
push_default_route bool: Defines whether the default route is enabled on that Gateway Network

ipamIpId String: Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
pushDefaultRoute Boolean: Defines whether the default route is enabled on that Gateway Network

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.getVpcGatewayNetwork

On this page

On this page

Example Usage

Using getVpcGatewayNetwork

getVpcGatewayNetwork Result

Supporting Types

GetVpcGatewayNetworkIpamConfig

Package Details

On this page

On this page