Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. VpcGatewayNetwork
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.VpcGatewayNetwork

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway
Deprecated: scaleway.index/vpcgatewaynetwork.VpcGatewayNetwork has been deprecated in favor of scaleway.network/gatewaynetwork.GatewayNetwork

Creates and manages GatewayNetworks (connections between a Public Gateway and a Private Network).

It allows the attachment of Private Networks to Public Gateways. For more information, see the API documentation.

Example Usage

Create a GatewayNetwork with IPAM configuration

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

const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
const pn01 = new scaleway.network.PrivateNetwork("pn01", {
    name: "pn_test_network",
    ipv4Subnet: {
        subnet: "172.16.64.0/22",
    },
    vpcId: vpc01.id,
});
const pg01 = new scaleway.network.PublicGateway("pg01", {
    name: "foobar",
    type: "VPC-GW-S",
});
const main = new scaleway.network.GatewayNetwork("main", {
    gatewayId: pg01.id,
    privateNetworkId: pn01.id,
    enableMasquerade: true,
    ipamConfigs: [{
        pushDefaultRoute: true,
    }],
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

vpc01 = scaleway.network.Vpc("vpc01", name="my vpc")
pn01 = scaleway.network.PrivateNetwork("pn01",
    name="pn_test_network",
    ipv4_subnet={
        "subnet": "172.16.64.0/22",
    },
    vpc_id=vpc01.id)
pg01 = scaleway.network.PublicGateway("pg01",
    name="foobar",
    type="VPC-GW-S")
main = scaleway.network.GatewayNetwork("main",
    gateway_id=pg01.id,
    private_network_id=pn01.id,
    enable_masquerade=True,
    ipam_configs=[{
        "push_default_route": True,
    }])
Copy
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 {
		vpc01, err := network.NewVpc(ctx, "vpc01", &network.VpcArgs{
			Name: pulumi.String("my vpc"),
		})
		if err != nil {
			return err
		}
		pn01, err := network.NewPrivateNetwork(ctx, "pn01", &network.PrivateNetworkArgs{
			Name: pulumi.String("pn_test_network"),
			Ipv4Subnet: &network.PrivateNetworkIpv4SubnetArgs{
				Subnet: pulumi.String("172.16.64.0/22"),
			},
			VpcId: vpc01.ID(),
		})
		if err != nil {
			return err
		}
		pg01, err := network.NewPublicGateway(ctx, "pg01", &network.PublicGatewayArgs{
			Name: pulumi.String("foobar"),
			Type: pulumi.String("VPC-GW-S"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewGatewayNetwork(ctx, "main", &network.GatewayNetworkArgs{
			GatewayId:        pg01.ID(),
			PrivateNetworkId: pn01.ID(),
			EnableMasquerade: pulumi.Bool(true),
			IpamConfigs: network.GatewayNetworkIpamConfigArray{
				&network.GatewayNetworkIpamConfigArgs{
					PushDefaultRoute: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var vpc01 = new Scaleway.Network.Vpc("vpc01", new()
    {
        Name = "my vpc",
    });

    var pn01 = new Scaleway.Network.PrivateNetwork("pn01", new()
    {
        Name = "pn_test_network",
        Ipv4Subnet = new Scaleway.Network.Inputs.PrivateNetworkIpv4SubnetArgs
        {
            Subnet = "172.16.64.0/22",
        },
        VpcId = vpc01.Id,
    });

    var pg01 = new Scaleway.Network.PublicGateway("pg01", new()
    {
        Name = "foobar",
        Type = "VPC-GW-S",
    });

    var main = new Scaleway.Network.GatewayNetwork("main", new()
    {
        GatewayId = pg01.Id,
        PrivateNetworkId = pn01.Id,
        EnableMasquerade = true,
        IpamConfigs = new[]
        {
            new Scaleway.Network.Inputs.GatewayNetworkIpamConfigArgs
            {
                PushDefaultRoute = true,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.Vpc;
import com.pulumi.scaleway.network.VpcArgs;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.network.PrivateNetworkArgs;
import com.pulumi.scaleway.network.inputs.PrivateNetworkIpv4SubnetArgs;
import com.pulumi.scaleway.network.PublicGateway;
import com.pulumi.scaleway.network.PublicGatewayArgs;
import com.pulumi.scaleway.network.GatewayNetwork;
import com.pulumi.scaleway.network.GatewayNetworkArgs;
import com.pulumi.scaleway.network.inputs.GatewayNetworkIpamConfigArgs;
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 vpc01 = new Vpc("vpc01", VpcArgs.builder()
            .name("my vpc")
            .build());

        var pn01 = new PrivateNetwork("pn01", PrivateNetworkArgs.builder()
            .name("pn_test_network")
            .ipv4Subnet(PrivateNetworkIpv4SubnetArgs.builder()
                .subnet("172.16.64.0/22")
                .build())
            .vpcId(vpc01.id())
            .build());

        var pg01 = new PublicGateway("pg01", PublicGatewayArgs.builder()
            .name("foobar")
            .type("VPC-GW-S")
            .build());

        var main = new GatewayNetwork("main", GatewayNetworkArgs.builder()
            .gatewayId(pg01.id())
            .privateNetworkId(pn01.id())
            .enableMasquerade(true)
            .ipamConfigs(GatewayNetworkIpamConfigArgs.builder()
                .pushDefaultRoute(true)
                .build())
            .build());

    }
}
Copy
resources:
  vpc01:
    type: scaleway:network:Vpc
    properties:
      name: my vpc
  pn01:
    type: scaleway:network:PrivateNetwork
    properties:
      name: pn_test_network
      ipv4Subnet:
        subnet: 172.16.64.0/22
      vpcId: ${vpc01.id}
  pg01:
    type: scaleway:network:PublicGateway
    properties:
      name: foobar
      type: VPC-GW-S
  main:
    type: scaleway:network:GatewayNetwork
    properties:
      gatewayId: ${pg01.id}
      privateNetworkId: ${pn01.id}
      enableMasquerade: true
      ipamConfigs:
        - pushDefaultRoute: true
Copy

Create a GatewayNetwork with a booked IPAM IP

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

const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
const pn01 = new scaleway.network.PrivateNetwork("pn01", {
    name: "pn_test_network",
    ipv4Subnet: {
        subnet: "172.16.64.0/22",
    },
    vpcId: vpc01.id,
});
const ip01 = new scaleway.ipam.Ip("ip01", {
    address: "172.16.64.7",
    sources: [{
        privateNetworkId: pn01.id,
    }],
});
const pg01 = new scaleway.network.PublicGateway("pg01", {
    name: "foobar",
    type: "VPC-GW-S",
});
const main = new scaleway.network.GatewayNetwork("main", {
    gatewayId: pg01.id,
    privateNetworkId: pn01.id,
    enableMasquerade: true,
    ipamConfigs: [{
        pushDefaultRoute: true,
        ipamIpId: ip01.id,
    }],
});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

vpc01 = scaleway.network.Vpc("vpc01", name="my vpc")
pn01 = scaleway.network.PrivateNetwork("pn01",
    name="pn_test_network",
    ipv4_subnet={
        "subnet": "172.16.64.0/22",
    },
    vpc_id=vpc01.id)
ip01 = scaleway.ipam.Ip("ip01",
    address="172.16.64.7",
    sources=[{
        "private_network_id": pn01.id,
    }])
pg01 = scaleway.network.PublicGateway("pg01",
    name="foobar",
    type="VPC-GW-S")
main = scaleway.network.GatewayNetwork("main",
    gateway_id=pg01.id,
    private_network_id=pn01.id,
    enable_masquerade=True,
    ipam_configs=[{
        "push_default_route": True,
        "ipam_ip_id": ip01.id,
    }])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		vpc01, err := network.NewVpc(ctx, "vpc01", &network.VpcArgs{
			Name: pulumi.String("my vpc"),
		})
		if err != nil {
			return err
		}
		pn01, err := network.NewPrivateNetwork(ctx, "pn01", &network.PrivateNetworkArgs{
			Name: pulumi.String("pn_test_network"),
			Ipv4Subnet: &network.PrivateNetworkIpv4SubnetArgs{
				Subnet: pulumi.String("172.16.64.0/22"),
			},
			VpcId: vpc01.ID(),
		})
		if err != nil {
			return err
		}
		ip01, err := ipam.NewIp(ctx, "ip01", &ipam.IpArgs{
			Address: pulumi.String("172.16.64.7"),
			Sources: ipam.IpSourceArray{
				&ipam.IpSourceArgs{
					PrivateNetworkId: pn01.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		pg01, err := network.NewPublicGateway(ctx, "pg01", &network.PublicGatewayArgs{
			Name: pulumi.String("foobar"),
			Type: pulumi.String("VPC-GW-S"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewGatewayNetwork(ctx, "main", &network.GatewayNetworkArgs{
			GatewayId:        pg01.ID(),
			PrivateNetworkId: pn01.ID(),
			EnableMasquerade: pulumi.Bool(true),
			IpamConfigs: network.GatewayNetworkIpamConfigArray{
				&network.GatewayNetworkIpamConfigArgs{
					PushDefaultRoute: pulumi.Bool(true),
					IpamIpId:         ip01.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var vpc01 = new Scaleway.Network.Vpc("vpc01", new()
    {
        Name = "my vpc",
    });

    var pn01 = new Scaleway.Network.PrivateNetwork("pn01", new()
    {
        Name = "pn_test_network",
        Ipv4Subnet = new Scaleway.Network.Inputs.PrivateNetworkIpv4SubnetArgs
        {
            Subnet = "172.16.64.0/22",
        },
        VpcId = vpc01.Id,
    });

    var ip01 = new Scaleway.Ipam.Ip("ip01", new()
    {
        Address = "172.16.64.7",
        Sources = new[]
        {
            new Scaleway.Ipam.Inputs.IpSourceArgs
            {
                PrivateNetworkId = pn01.Id,
            },
        },
    });

    var pg01 = new Scaleway.Network.PublicGateway("pg01", new()
    {
        Name = "foobar",
        Type = "VPC-GW-S",
    });

    var main = new Scaleway.Network.GatewayNetwork("main", new()
    {
        GatewayId = pg01.Id,
        PrivateNetworkId = pn01.Id,
        EnableMasquerade = true,
        IpamConfigs = new[]
        {
            new Scaleway.Network.Inputs.GatewayNetworkIpamConfigArgs
            {
                PushDefaultRoute = true,
                IpamIpId = ip01.Id,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.Vpc;
import com.pulumi.scaleway.network.VpcArgs;
import com.pulumi.scaleway.network.PrivateNetwork;
import com.pulumi.scaleway.network.PrivateNetworkArgs;
import com.pulumi.scaleway.network.inputs.PrivateNetworkIpv4SubnetArgs;
import com.pulumi.scaleway.ipam.Ip;
import com.pulumi.scaleway.ipam.IpArgs;
import com.pulumi.scaleway.ipam.inputs.IpSourceArgs;
import com.pulumi.scaleway.network.PublicGateway;
import com.pulumi.scaleway.network.PublicGatewayArgs;
import com.pulumi.scaleway.network.GatewayNetwork;
import com.pulumi.scaleway.network.GatewayNetworkArgs;
import com.pulumi.scaleway.network.inputs.GatewayNetworkIpamConfigArgs;
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 vpc01 = new Vpc("vpc01", VpcArgs.builder()
            .name("my vpc")
            .build());

        var pn01 = new PrivateNetwork("pn01", PrivateNetworkArgs.builder()
            .name("pn_test_network")
            .ipv4Subnet(PrivateNetworkIpv4SubnetArgs.builder()
                .subnet("172.16.64.0/22")
                .build())
            .vpcId(vpc01.id())
            .build());

        var ip01 = new Ip("ip01", IpArgs.builder()
            .address("172.16.64.7")
            .sources(IpSourceArgs.builder()
                .privateNetworkId(pn01.id())
                .build())
            .build());

        var pg01 = new PublicGateway("pg01", PublicGatewayArgs.builder()
            .name("foobar")
            .type("VPC-GW-S")
            .build());

        var main = new GatewayNetwork("main", GatewayNetworkArgs.builder()
            .gatewayId(pg01.id())
            .privateNetworkId(pn01.id())
            .enableMasquerade(true)
            .ipamConfigs(GatewayNetworkIpamConfigArgs.builder()
                .pushDefaultRoute(true)
                .ipamIpId(ip01.id())
                .build())
            .build());

    }
}
Copy
resources:
  vpc01:
    type: scaleway:network:Vpc
    properties:
      name: my vpc
  pn01:
    type: scaleway:network:PrivateNetwork
    properties:
      name: pn_test_network
      ipv4Subnet:
        subnet: 172.16.64.0/22
      vpcId: ${vpc01.id}
  ip01:
    type: scaleway:ipam:Ip
    properties:
      address: 172.16.64.7
      sources:
        - privateNetworkId: ${pn01.id}
  pg01:
    type: scaleway:network:PublicGateway
    properties:
      name: foobar
      type: VPC-GW-S
  main:
    type: scaleway:network:GatewayNetwork
    properties:
      gatewayId: ${pg01.id}
      privateNetworkId: ${pn01.id}
      enableMasquerade: true
      ipamConfigs:
        - pushDefaultRoute: true
          ipamIpId: ${ip01.id}
Copy

Create VpcGatewayNetwork Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VpcGatewayNetwork(name: string, args: VpcGatewayNetworkArgs, opts?: CustomResourceOptions);
@overload
def VpcGatewayNetwork(resource_name: str,
                      args: VpcGatewayNetworkArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def VpcGatewayNetwork(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cleanup_dhcp: Optional[bool] = None,
                      dhcp_id: Optional[str] = None,
                      enable_dhcp: Optional[bool] = None,
                      enable_masquerade: Optional[bool] = None,
                      gateway_id: Optional[str] = None,
                      ipam_configs: Optional[Sequence[VpcGatewayNetworkIpamConfigArgs]] = None,
                      private_network_id: Optional[str] = None,
                      static_address: Optional[str] = None,
                      zone: Optional[str] = None)
func NewVpcGatewayNetwork(ctx *Context, name string, args VpcGatewayNetworkArgs, opts ...ResourceOption) (*VpcGatewayNetwork, error)
public VpcGatewayNetwork(string name, VpcGatewayNetworkArgs args, CustomResourceOptions? opts = null)
public VpcGatewayNetwork(String name, VpcGatewayNetworkArgs args)
public VpcGatewayNetwork(String name, VpcGatewayNetworkArgs args, CustomResourceOptions options)

type: scaleway:VpcGatewayNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcGatewayNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcGatewayNetworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcGatewayNetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcGatewayNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcGatewayNetworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

VpcGatewayNetwork Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VpcGatewayNetwork resource accepts the following input properties:

GatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Public Gateway.
PrivateNetworkId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Private Network.
CleanupDhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

DhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableDhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableMasquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
IpamConfigs List<Pulumiverse.Scaleway.Inputs.VpcGatewayNetworkIpamConfig>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
StaticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

Zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

GatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Public Gateway.
PrivateNetworkId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Private Network.
CleanupDhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

DhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableDhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableMasquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
IpamConfigs []VpcGatewayNetworkIpamConfigArgs
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
StaticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

Zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

gatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Public Gateway.
privateNetworkId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Private Network.
cleanupDhcp Boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

dhcpId String
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp Boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade Boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
ipamConfigs List<VpcGatewayNetworkIpamConfig>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
staticAddress String
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

zone Changes to this property will trigger replacement. String

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

gatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Public Gateway.
privateNetworkId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Private Network.
cleanupDhcp boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

dhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
ipamConfigs VpcGatewayNetworkIpamConfig[]
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
staticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

gateway_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Public Gateway.
private_network_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Private Network.
cleanup_dhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

dhcp_id str
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enable_dhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enable_masquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
ipam_configs Sequence[VpcGatewayNetworkIpamConfigArgs]
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
static_address str
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

zone Changes to this property will trigger replacement. str

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

gatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Public Gateway.
privateNetworkId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Private Network.
cleanupDhcp Boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

dhcpId String
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp Boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade Boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
ipamConfigs List<Property Map>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
staticAddress String
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

zone Changes to this property will trigger replacement. String

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpcGatewayNetwork resource produces the following output properties:

CreatedAt string
The date and time of the creation of the GatewayNetwork.
Id string
The provider-assigned unique ID for this managed resource.
MacAddress string
The MAC address of the GatewayNetwork.
Status string
The status of the Public Gateway's connection to the Private Network.
UpdatedAt string
The date and time of the last update of the GatewayNetwork.
CreatedAt string
The date and time of the creation of the GatewayNetwork.
Id string
The provider-assigned unique ID for this managed resource.
MacAddress string
The MAC address of the GatewayNetwork.
Status string
The status of the Public Gateway's connection to the Private Network.
UpdatedAt string
The date and time of the last update of the GatewayNetwork.
createdAt String
The date and time of the creation of the GatewayNetwork.
id String
The provider-assigned unique ID for this managed resource.
macAddress String
The MAC address of the GatewayNetwork.
status String
The status of the Public Gateway's connection to the Private Network.
updatedAt String
The date and time of the last update of the GatewayNetwork.
createdAt string
The date and time of the creation of the GatewayNetwork.
id string
The provider-assigned unique ID for this managed resource.
macAddress string
The MAC address of the GatewayNetwork.
status string
The status of the Public Gateway's connection to the Private Network.
updatedAt string
The date and time of the last update of the GatewayNetwork.
created_at str
The date and time of the creation of the GatewayNetwork.
id str
The provider-assigned unique ID for this managed resource.
mac_address str
The MAC address of the GatewayNetwork.
status str
The status of the Public Gateway's connection to the Private Network.
updated_at str
The date and time of the last update of the GatewayNetwork.
createdAt String
The date and time of the creation of the GatewayNetwork.
id String
The provider-assigned unique ID for this managed resource.
macAddress String
The MAC address of the GatewayNetwork.
status String
The status of the Public Gateway's connection to the Private Network.
updatedAt String
The date and time of the last update of the GatewayNetwork.

Look up Existing VpcGatewayNetwork Resource

Get an existing VpcGatewayNetwork resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcGatewayNetworkState, opts?: CustomResourceOptions): VpcGatewayNetwork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cleanup_dhcp: Optional[bool] = None,
        created_at: Optional[str] = None,
        dhcp_id: Optional[str] = None,
        enable_dhcp: Optional[bool] = None,
        enable_masquerade: Optional[bool] = None,
        gateway_id: Optional[str] = None,
        ipam_configs: Optional[Sequence[VpcGatewayNetworkIpamConfigArgs]] = None,
        mac_address: Optional[str] = None,
        private_network_id: Optional[str] = None,
        static_address: Optional[str] = None,
        status: Optional[str] = None,
        updated_at: Optional[str] = None,
        zone: Optional[str] = None) -> VpcGatewayNetwork
func GetVpcGatewayNetwork(ctx *Context, name string, id IDInput, state *VpcGatewayNetworkState, opts ...ResourceOption) (*VpcGatewayNetwork, error)
public static VpcGatewayNetwork Get(string name, Input<string> id, VpcGatewayNetworkState? state, CustomResourceOptions? opts = null)
public static VpcGatewayNetwork get(String name, Output<String> id, VpcGatewayNetworkState state, CustomResourceOptions options)
resources:  _:    type: scaleway:VpcGatewayNetwork    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CleanupDhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

CreatedAt string
The date and time of the creation of the GatewayNetwork.
DhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableDhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableMasquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
GatewayId Changes to this property will trigger replacement. string
The ID of the Public Gateway.
IpamConfigs List<Pulumiverse.Scaleway.Inputs.VpcGatewayNetworkIpamConfig>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
MacAddress string
The MAC address of the GatewayNetwork.
PrivateNetworkId Changes to this property will trigger replacement. string
The ID of the Private Network.
StaticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

Status string
The status of the Public Gateway's connection to the Private Network.
UpdatedAt string
The date and time of the last update of the GatewayNetwork.
Zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

CleanupDhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

CreatedAt string
The date and time of the creation of the GatewayNetwork.
DhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableDhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

EnableMasquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
GatewayId Changes to this property will trigger replacement. string
The ID of the Public Gateway.
IpamConfigs []VpcGatewayNetworkIpamConfigArgs
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
MacAddress string
The MAC address of the GatewayNetwork.
PrivateNetworkId Changes to this property will trigger replacement. string
The ID of the Private Network.
StaticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

Status string
The status of the Public Gateway's connection to the Private Network.
UpdatedAt string
The date and time of the last update of the GatewayNetwork.
Zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

cleanupDhcp Boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

createdAt String
The date and time of the creation of the GatewayNetwork.
dhcpId String
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp Boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade Boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
gatewayId Changes to this property will trigger replacement. String
The ID of the Public Gateway.
ipamConfigs List<VpcGatewayNetworkIpamConfig>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
macAddress String
The MAC address of the GatewayNetwork.
privateNetworkId Changes to this property will trigger replacement. String
The ID of the Private Network.
staticAddress String
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

status String
The status of the Public Gateway's connection to the Private Network.
updatedAt String
The date and time of the last update of the GatewayNetwork.
zone Changes to this property will trigger replacement. String

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

cleanupDhcp boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

createdAt string
The date and time of the creation of the GatewayNetwork.
dhcpId string
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
gatewayId Changes to this property will trigger replacement. string
The ID of the Public Gateway.
ipamConfigs VpcGatewayNetworkIpamConfig[]
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
macAddress string
The MAC address of the GatewayNetwork.
privateNetworkId Changes to this property will trigger replacement. string
The ID of the Private Network.
staticAddress string
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

status string
The status of the Public Gateway's connection to the Private Network.
updatedAt string
The date and time of the last update of the GatewayNetwork.
zone Changes to this property will trigger replacement. string

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

cleanup_dhcp bool
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

created_at str
The date and time of the creation of the GatewayNetwork.
dhcp_id str
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enable_dhcp bool
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enable_masquerade bool
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
gateway_id Changes to this property will trigger replacement. str
The ID of the Public Gateway.
ipam_configs Sequence[VpcGatewayNetworkIpamConfigArgs]
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
mac_address str
The MAC address of the GatewayNetwork.
private_network_id Changes to this property will trigger replacement. str
The ID of the Private Network.
static_address str
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

status str
The status of the Public Gateway's connection to the Private Network.
updated_at str
The date and time of the last update of the GatewayNetwork.
zone Changes to this property will trigger replacement. str

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

cleanupDhcp Boolean
Please use ipam_config. Whether to remove DHCP configuration on this GatewayNetwork upon destroy. Requires DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

createdAt String
The date and time of the creation of the GatewayNetwork.
dhcpId String
Please use ipam_config. The ID of the Public Gateway DHCP configuration. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableDhcp Boolean
Please use ipam_config. Whether a DHCP configuration should be enabled on this GatewayNetwork. Requires a DHCP ID.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

enableMasquerade Boolean
Whether masquerade (dynamic NAT) should be enabled on this GatewayNetwork.
gatewayId Changes to this property will trigger replacement. String
The ID of the Public Gateway.
ipamConfigs List<Property Map>
Auto-configure the GatewayNetwork using Scaleway's IPAM (IP address management service). Only one of dhcp_id, static_address and ipam_config should be specified.
macAddress String
The MAC address of the GatewayNetwork.
privateNetworkId Changes to this property will trigger replacement. String
The ID of the Private Network.
staticAddress String
Please use ipam_config. Enable DHCP configration on this GatewayNetwork. Only one of dhcp_id, static_address and ipam_config should be specified.

Deprecated: Please use ipam_config. For more information, please refer to the dedicated guide: https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/guides/migration_guide_vpcgw_v2.md

status String
The status of the Public Gateway's connection to the Private Network.
updatedAt String
The date and time of the last update of the GatewayNetwork.
zone Changes to this property will trigger replacement. String

zone) The zone in which the gateway network should be created.

Important: In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP fields are now deprecated. For more information, please refer to the dedicated guide.

Supporting Types

VpcGatewayNetworkIpamConfig
, VpcGatewayNetworkIpamConfigArgs

IpamIpId string
Use this IPAM-booked IP ID as the Gateway's IP in this Private Network.
PushDefaultRoute bool
Defines whether to enable the default route on the GatewayNetwork.
IpamIpId string
Use this IPAM-booked IP ID as the Gateway's IP in this Private Network.
PushDefaultRoute bool
Defines whether to enable the default route on the GatewayNetwork.
ipamIpId String
Use this IPAM-booked IP ID as the Gateway's IP in this Private Network.
pushDefaultRoute Boolean
Defines whether to enable the default route on the GatewayNetwork.
ipamIpId string
Use this IPAM-booked IP ID as the Gateway's IP in this Private Network.
pushDefaultRoute boolean
Defines whether to enable the default route on the GatewayNetwork.
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 to enable the default route on the GatewayNetwork.
ipamIpId String
Use this IPAM-booked IP ID as the Gateway's IP in this Private Network.
pushDefaultRoute Boolean
Defines whether to enable the default route on the GatewayNetwork.

Import

GatewayNetwork can be imported using {zone}/{id}, e.g.

bash

$ pulumi import scaleway:index/vpcGatewayNetwork:VpcGatewayNetwork main fr-par-1/11111111-1111-1111-1111-111111111111
Copy

To learn more about importing existing cloud resources, see Importing resources.

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