1. Packages
  2. Scaleway
  3. API Docs
  4. network
  5. PublicGatewayDhcp
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.network.PublicGatewayDhcp

Explore with Pulumi AI

Important: The resource scaleway.network.PublicGatewayDhcp has been deprecated and will no longer be supported. In 2023, DHCP functionality was moved from Public Gateways to Private Networks, DHCP resources are now no longer needed. For more information, please refer to the dedicated guide.

Creates and manages Scaleway VPC Public Gateway DHCP configurations. For more information, see the API documentation.

Example Usage

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

const main = new scaleway.network.PublicGatewayDhcp("main", {subnet: "192.168.1.0/24"});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

main = scaleway.network.PublicGatewayDhcp("main", subnet="192.168.1.0/24")
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 {
		_, err := network.NewPublicGatewayDhcp(ctx, "main", &network.PublicGatewayDhcpArgs{
			Subnet: pulumi.String("192.168.1.0/24"),
		})
		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 main = new Scaleway.Network.PublicGatewayDhcp("main", new()
    {
        Subnet = "192.168.1.0/24",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.network.PublicGatewayDhcp;
import com.pulumi.scaleway.network.PublicGatewayDhcpArgs;
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 PublicGatewayDhcp("main", PublicGatewayDhcpArgs.builder()
            .subnet("192.168.1.0/24")
            .build());

    }
}
Copy
resources:
  main:
    type: scaleway:network:PublicGatewayDhcp
    properties:
      subnet: 192.168.1.0/24
Copy

Create PublicGatewayDhcp Resource

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

Constructor syntax

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

@overload
def PublicGatewayDhcp(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      subnet: Optional[str] = None,
                      pool_low: Optional[str] = None,
                      push_default_route: Optional[bool] = None,
                      dns_servers_overrides: Optional[Sequence[str]] = None,
                      enable_dynamic: Optional[bool] = None,
                      pool_high: Optional[str] = None,
                      address: Optional[str] = None,
                      project_id: Optional[str] = None,
                      dns_searches: Optional[Sequence[str]] = None,
                      push_dns_server: Optional[bool] = None,
                      rebind_timer: Optional[int] = None,
                      renew_timer: Optional[int] = None,
                      dns_local_name: Optional[str] = None,
                      valid_lifetime: Optional[int] = None,
                      zone: Optional[str] = None)
func NewPublicGatewayDhcp(ctx *Context, name string, args PublicGatewayDhcpArgs, opts ...ResourceOption) (*PublicGatewayDhcp, error)
public PublicGatewayDhcp(string name, PublicGatewayDhcpArgs args, CustomResourceOptions? opts = null)
public PublicGatewayDhcp(String name, PublicGatewayDhcpArgs args)
public PublicGatewayDhcp(String name, PublicGatewayDhcpArgs args, CustomResourceOptions options)
type: scaleway:network:PublicGatewayDhcp
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. PublicGatewayDhcpArgs
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. PublicGatewayDhcpArgs
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. PublicGatewayDhcpArgs
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. PublicGatewayDhcpArgs
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. PublicGatewayDhcpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var publicGatewayDhcpResource = new Scaleway.Network.PublicGatewayDhcp("publicGatewayDhcpResource", new()
{
    Subnet = "string",
    PoolLow = "string",
    PushDefaultRoute = false,
    DnsServersOverrides = new[]
    {
        "string",
    },
    EnableDynamic = false,
    PoolHigh = "string",
    Address = "string",
    ProjectId = "string",
    DnsSearches = new[]
    {
        "string",
    },
    PushDnsServer = false,
    RebindTimer = 0,
    RenewTimer = 0,
    DnsLocalName = "string",
    ValidLifetime = 0,
    Zone = "string",
});
Copy
example, err := network.NewPublicGatewayDhcp(ctx, "publicGatewayDhcpResource", &network.PublicGatewayDhcpArgs{
	Subnet:           pulumi.String("string"),
	PoolLow:          pulumi.String("string"),
	PushDefaultRoute: pulumi.Bool(false),
	DnsServersOverrides: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableDynamic: pulumi.Bool(false),
	PoolHigh:      pulumi.String("string"),
	Address:       pulumi.String("string"),
	ProjectId:     pulumi.String("string"),
	DnsSearches: pulumi.StringArray{
		pulumi.String("string"),
	},
	PushDnsServer: pulumi.Bool(false),
	RebindTimer:   pulumi.Int(0),
	RenewTimer:    pulumi.Int(0),
	DnsLocalName:  pulumi.String("string"),
	ValidLifetime: pulumi.Int(0),
	Zone:          pulumi.String("string"),
})
Copy
var publicGatewayDhcpResource = new PublicGatewayDhcp("publicGatewayDhcpResource", PublicGatewayDhcpArgs.builder()
    .subnet("string")
    .poolLow("string")
    .pushDefaultRoute(false)
    .dnsServersOverrides("string")
    .enableDynamic(false)
    .poolHigh("string")
    .address("string")
    .projectId("string")
    .dnsSearches("string")
    .pushDnsServer(false)
    .rebindTimer(0)
    .renewTimer(0)
    .dnsLocalName("string")
    .validLifetime(0)
    .zone("string")
    .build());
Copy
public_gateway_dhcp_resource = scaleway.network.PublicGatewayDhcp("publicGatewayDhcpResource",
    subnet="string",
    pool_low="string",
    push_default_route=False,
    dns_servers_overrides=["string"],
    enable_dynamic=False,
    pool_high="string",
    address="string",
    project_id="string",
    dns_searches=["string"],
    push_dns_server=False,
    rebind_timer=0,
    renew_timer=0,
    dns_local_name="string",
    valid_lifetime=0,
    zone="string")
Copy
const publicGatewayDhcpResource = new scaleway.network.PublicGatewayDhcp("publicGatewayDhcpResource", {
    subnet: "string",
    poolLow: "string",
    pushDefaultRoute: false,
    dnsServersOverrides: ["string"],
    enableDynamic: false,
    poolHigh: "string",
    address: "string",
    projectId: "string",
    dnsSearches: ["string"],
    pushDnsServer: false,
    rebindTimer: 0,
    renewTimer: 0,
    dnsLocalName: "string",
    validLifetime: 0,
    zone: "string",
});
Copy
type: scaleway:network:PublicGatewayDhcp
properties:
    address: string
    dnsLocalName: string
    dnsSearches:
        - string
    dnsServersOverrides:
        - string
    enableDynamic: false
    poolHigh: string
    poolLow: string
    projectId: string
    pushDefaultRoute: false
    pushDnsServer: false
    rebindTimer: 0
    renewTimer: 0
    subnet: string
    validLifetime: 0
    zone: string
Copy

PublicGatewayDhcp 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 PublicGatewayDhcp resource accepts the following input properties:

Subnet This property is required. string
The subnet to associate with the Public Gateway DHCP configuration.
Address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
DnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
DnsSearches List<string>
Additional DNS search paths
DnsServersOverrides List<string>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
EnableDynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
PoolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
PoolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
PushDefaultRoute bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

PushDnsServer bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
RebindTimer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
RenewTimer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
ValidLifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
Subnet This property is required. string
The subnet to associate with the Public Gateway DHCP configuration.
Address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
DnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
DnsSearches []string
Additional DNS search paths
DnsServersOverrides []string
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
EnableDynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
PoolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
PoolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
PushDefaultRoute bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

PushDnsServer bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
RebindTimer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
RenewTimer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
ValidLifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
subnet This property is required. String
The subnet to associate with the Public Gateway DHCP configuration.
address String
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
dnsLocalName String
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches List<String>
Additional DNS search paths
dnsServersOverrides List<String>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic Boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
poolHigh String
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow String
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute Boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer Boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer Integer
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer Integer
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
validLifetime Integer
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. String
zone) The zone in which the Public Gateway DHCP configuration should be created.
subnet This property is required. string
The subnet to associate with the Public Gateway DHCP configuration.
address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
dnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches string[]
Additional DNS search paths
dnsServersOverrides string[]
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
poolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer number
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer number
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
validLifetime number
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
subnet This property is required. str
The subnet to associate with the Public Gateway DHCP configuration.
address str
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
dns_local_name str
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dns_searches Sequence[str]
Additional DNS search paths
dns_servers_overrides Sequence[str]
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enable_dynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
pool_high str
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
pool_low str
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
push_default_route bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

push_dns_server bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebind_timer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renew_timer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
valid_lifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. str
zone) The zone in which the Public Gateway DHCP configuration should be created.
subnet This property is required. String
The subnet to associate with the Public Gateway DHCP configuration.
address String
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
dnsLocalName String
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches List<String>
Additional DNS search paths
dnsServersOverrides List<String>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic Boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
poolHigh String
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow String
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute Boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer Boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer Number
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer Number
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
validLifetime Number
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. String
zone) The zone in which the Public Gateway DHCP configuration should be created.

Outputs

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

CreatedAt string
The date and time of the creation of the Public Gateway DHCP configuration.
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The Organization ID the Public Gateway DHCP config is associated with.
UpdatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
CreatedAt string
The date and time of the creation of the Public Gateway DHCP configuration.
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The Organization ID the Public Gateway DHCP config is associated with.
UpdatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
createdAt String
The date and time of the creation of the Public Gateway DHCP configuration.
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The Organization ID the Public Gateway DHCP config is associated with.
updatedAt String
The date and time of the last update of the Public Gateway DHCP configuration.
createdAt string
The date and time of the creation of the Public Gateway DHCP configuration.
id string
The provider-assigned unique ID for this managed resource.
organizationId string
The Organization ID the Public Gateway DHCP config is associated with.
updatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
created_at str
The date and time of the creation of the Public Gateway DHCP configuration.
id str
The provider-assigned unique ID for this managed resource.
organization_id str
The Organization ID the Public Gateway DHCP config is associated with.
updated_at str
The date and time of the last update of the Public Gateway DHCP configuration.
createdAt String
The date and time of the creation of the Public Gateway DHCP configuration.
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The Organization ID the Public Gateway DHCP config is associated with.
updatedAt String
The date and time of the last update of the Public Gateway DHCP configuration.

Look up Existing PublicGatewayDhcp Resource

Get an existing PublicGatewayDhcp 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?: PublicGatewayDhcpState, opts?: CustomResourceOptions): PublicGatewayDhcp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        created_at: Optional[str] = None,
        dns_local_name: Optional[str] = None,
        dns_searches: Optional[Sequence[str]] = None,
        dns_servers_overrides: Optional[Sequence[str]] = None,
        enable_dynamic: Optional[bool] = None,
        organization_id: Optional[str] = None,
        pool_high: Optional[str] = None,
        pool_low: Optional[str] = None,
        project_id: Optional[str] = None,
        push_default_route: Optional[bool] = None,
        push_dns_server: Optional[bool] = None,
        rebind_timer: Optional[int] = None,
        renew_timer: Optional[int] = None,
        subnet: Optional[str] = None,
        updated_at: Optional[str] = None,
        valid_lifetime: Optional[int] = None,
        zone: Optional[str] = None) -> PublicGatewayDhcp
func GetPublicGatewayDhcp(ctx *Context, name string, id IDInput, state *PublicGatewayDhcpState, opts ...ResourceOption) (*PublicGatewayDhcp, error)
public static PublicGatewayDhcp Get(string name, Input<string> id, PublicGatewayDhcpState? state, CustomResourceOptions? opts = null)
public static PublicGatewayDhcp get(String name, Output<String> id, PublicGatewayDhcpState state, CustomResourceOptions options)
resources:  _:    type: scaleway:network:PublicGatewayDhcp    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:
Address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
CreatedAt string
The date and time of the creation of the Public Gateway DHCP configuration.
DnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
DnsSearches List<string>
Additional DNS search paths
DnsServersOverrides List<string>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
EnableDynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
OrganizationId string
The Organization ID the Public Gateway DHCP config is associated with.
PoolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
PoolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
PushDefaultRoute bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

PushDnsServer bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
RebindTimer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
RenewTimer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
Subnet string
The subnet to associate with the Public Gateway DHCP configuration.
UpdatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
ValidLifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
Address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
CreatedAt string
The date and time of the creation of the Public Gateway DHCP configuration.
DnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
DnsSearches []string
Additional DNS search paths
DnsServersOverrides []string
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
EnableDynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
OrganizationId string
The Organization ID the Public Gateway DHCP config is associated with.
PoolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
PoolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
PushDefaultRoute bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

PushDnsServer bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
RebindTimer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
RenewTimer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
Subnet string
The subnet to associate with the Public Gateway DHCP configuration.
UpdatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
ValidLifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
address String
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
createdAt String
The date and time of the creation of the Public Gateway DHCP configuration.
dnsLocalName String
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches List<String>
Additional DNS search paths
dnsServersOverrides List<String>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic Boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
organizationId String
The Organization ID the Public Gateway DHCP config is associated with.
poolHigh String
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow String
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute Boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer Boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer Integer
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer Integer
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
subnet String
The subnet to associate with the Public Gateway DHCP configuration.
updatedAt String
The date and time of the last update of the Public Gateway DHCP configuration.
validLifetime Integer
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. String
zone) The zone in which the Public Gateway DHCP configuration should be created.
address string
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
createdAt string
The date and time of the creation of the Public Gateway DHCP configuration.
dnsLocalName string
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches string[]
Additional DNS search paths
dnsServersOverrides string[]
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
organizationId string
The Organization ID the Public Gateway DHCP config is associated with.
poolHigh string
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer number
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer number
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
subnet string
The subnet to associate with the Public Gateway DHCP configuration.
updatedAt string
The date and time of the last update of the Public Gateway DHCP configuration.
validLifetime number
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. string
zone) The zone in which the Public Gateway DHCP configuration should be created.
address str
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
created_at str
The date and time of the creation of the Public Gateway DHCP configuration.
dns_local_name str
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dns_searches Sequence[str]
Additional DNS search paths
dns_servers_overrides Sequence[str]
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enable_dynamic bool
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
organization_id str
The Organization ID the Public Gateway DHCP config is associated with.
pool_high str
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
pool_low str
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
push_default_route bool

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

push_dns_server bool
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebind_timer int
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renew_timer int
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
subnet str
The subnet to associate with the Public Gateway DHCP configuration.
updated_at str
The date and time of the last update of the Public Gateway DHCP configuration.
valid_lifetime int
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. str
zone) The zone in which the Public Gateway DHCP configuration should be created.
address String
The IP address of the DHCP server. This will be the gateway's address in the Private Network.
createdAt String
The date and time of the creation of the Public Gateway DHCP configuration.
dnsLocalName String
TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.
dnsSearches List<String>
Additional DNS search paths
dnsServersOverrides List<String>
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
enableDynamic Boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true.
organizationId String
The Organization ID the Public Gateway DHCP config is associated with.
poolHigh String
High IP (excluded) of the dynamic address pool. Defaults to the last address of the subnet.
poolLow String
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the Public Gateway DHCP configuration is associated with.
pushDefaultRoute Boolean

Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.

Warning: If you need to setup a default route, it's recommended to use the scaleway.network.GatewayNetwork resource instead.

pushDnsServer Boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname > IP resolution. Defaults to true.
rebindTimer Number
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime. Defaults to 51m (3060s).
renewTimer Number
After how long, in seconds, a renewal will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).
subnet String
The subnet to associate with the Public Gateway DHCP configuration.
updatedAt String
The date and time of the last update of the Public Gateway DHCP configuration.
validLifetime Number
How long, in seconds, DHCP entries will be valid. Defaults to 1h (3600s).
zone Changes to this property will trigger replacement. String
zone) The zone in which the Public Gateway DHCP configuration should be created.

Import

Public Gateway DHCP configuration can be imported using {zone}/{id}, e.g.

bash

$ pulumi import scaleway:network/publicGatewayDhcp:PublicGatewayDhcp 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.