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

scaleway.loadbalancers.Ip

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

Creates and manages Scaleway Load Balancer IP addresses.

For more information, see the main documentation or API documentation.

Example Usage

Basic

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

const ip = new scaleway.loadbalancers.Ip("ip", {reverse: "my-reverse.com"});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

ip = scaleway.loadbalancers.Ip("ip", reverse="my-reverse.com")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancers.NewIp(ctx, "ip", &loadbalancers.IpArgs{
			Reverse: pulumi.String("my-reverse.com"),
		})
		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 ip = new Scaleway.Loadbalancers.Ip("ip", new()
    {
        Reverse = "my-reverse.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Ip;
import com.pulumi.scaleway.loadbalancers.IpArgs;
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 ip = new Ip("ip", IpArgs.builder()
            .reverse("my-reverse.com")
            .build());

    }
}
Copy
resources:
  ip:
    type: scaleway:loadbalancers:Ip
    properties:
      reverse: my-reverse.com
Copy

With IPv6

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

const ipv6 = new scaleway.loadbalancers.Ip("ipv6", {isIpv6: true});
Copy
import pulumi
import pulumiverse_scaleway as scaleway

ipv6 = scaleway.loadbalancers.Ip("ipv6", is_ipv6=True)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancers.NewIp(ctx, "ipv6", &loadbalancers.IpArgs{
			IsIpv6: 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 ipv6 = new Scaleway.Loadbalancers.Ip("ipv6", new()
    {
        IsIpv6 = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.Ip;
import com.pulumi.scaleway.loadbalancers.IpArgs;
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 ipv6 = new Ip("ipv6", IpArgs.builder()
            .isIpv6(true)
            .build());

    }
}
Copy
resources:
  ipv6:
    type: scaleway:loadbalancers:Ip
    properties:
      isIpv6: true
Copy

Create Ip Resource

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

Constructor syntax

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

@overload
def Ip(resource_name: str,
       opts: Optional[ResourceOptions] = None,
       is_ipv6: Optional[bool] = None,
       project_id: Optional[str] = None,
       reverse: Optional[str] = None,
       tags: Optional[Sequence[str]] = None,
       zone: Optional[str] = None)
func NewIp(ctx *Context, name string, args *IpArgs, opts ...ResourceOption) (*Ip, error)
public Ip(string name, IpArgs? args = null, CustomResourceOptions? opts = null)
public Ip(String name, IpArgs args)
public Ip(String name, IpArgs args, CustomResourceOptions options)

type: scaleway:loadbalancers:Ip
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 IpArgs
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 IpArgs
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 IpArgs
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 IpArgs
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. IpArgs
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 exampleipResourceResourceFromLoadbalancersip = new Scaleway.Loadbalancers.Ip("exampleipResourceResourceFromLoadbalancersip", new()
{
    IsIpv6 = false,
    ProjectId = "string",
    Reverse = "string",
    Tags = new[]
    {
        "string",
    },
    Zone = "string",
});
Copy
example, err := loadbalancers.NewIp(ctx, "exampleipResourceResourceFromLoadbalancersip", &loadbalancers.IpArgs{
	IsIpv6:    pulumi.Bool(false),
	ProjectId: pulumi.String("string"),
	Reverse:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})
Copy
var exampleipResourceResourceFromLoadbalancersip = new Ip("exampleipResourceResourceFromLoadbalancersip", IpArgs.builder()
    .isIpv6(false)
    .projectId("string")
    .reverse("string")
    .tags("string")
    .zone("string")
    .build());
Copy
exampleip_resource_resource_from_loadbalancersip = scaleway.loadbalancers.Ip("exampleipResourceResourceFromLoadbalancersip",
    is_ipv6=False,
    project_id="string",
    reverse="string",
    tags=["string"],
    zone="string")
Copy
const exampleipResourceResourceFromLoadbalancersip = new scaleway.loadbalancers.Ip("exampleipResourceResourceFromLoadbalancersip", {
    isIpv6: false,
    projectId: "string",
    reverse: "string",
    tags: ["string"],
    zone: "string",
});
Copy
type: scaleway:loadbalancers:Ip
properties:
    isIpv6: false
    projectId: string
    reverse: string
    tags:
        - string
    zone: string
Copy

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

IsIpv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
Reverse string
The reverse domain associated with this IP.
Tags List<string>
The tags associated with this IP.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
IsIpv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
Reverse string
The reverse domain associated with this IP.
Tags []string
The tags associated with this IP.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
isIpv6 Changes to this property will trigger replacement. Boolean
If true, creates a flexible IP with an IPv6 address.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the IP is associated with.
reverse String
The reverse domain associated with this IP.
tags List<String>
The tags associated with this IP.
zone Changes to this property will trigger replacement. String
zone) The zone in which the IP should be reserved.
isIpv6 Changes to this property will trigger replacement. boolean
If true, creates a flexible IP with an IPv6 address.
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
reverse string
The reverse domain associated with this IP.
tags string[]
The tags associated with this IP.
zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
is_ipv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the IP is associated with.
reverse str
The reverse domain associated with this IP.
tags Sequence[str]
The tags associated with this IP.
zone Changes to this property will trigger replacement. str
zone) The zone in which the IP should be reserved.
isIpv6 Changes to this property will trigger replacement. Boolean
If true, creates a flexible IP with an IPv6 address.
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the IP is associated with.
reverse String
The reverse domain associated with this IP.
tags List<String>
The tags associated with this IP.
zone Changes to this property will trigger replacement. String
zone) The zone in which the IP should be reserved.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The IP address
LbId string
The associated Load Balancer ID if any
OrganizationId string
The organization_id you want to attach the resource to
Region string
The region of the resource
Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The IP address
LbId string
The associated Load Balancer ID if any
OrganizationId string
The organization_id you want to attach the resource to
Region string
The region of the resource
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The IP address
lbId String
The associated Load Balancer ID if any
organizationId String
The organization_id you want to attach the resource to
region String
The region of the resource
id string
The provider-assigned unique ID for this managed resource.
ipAddress string
The IP address
lbId string
The associated Load Balancer ID if any
organizationId string
The organization_id you want to attach the resource to
region string
The region of the resource
id str
The provider-assigned unique ID for this managed resource.
ip_address str
The IP address
lb_id str
The associated Load Balancer ID if any
organization_id str
The organization_id you want to attach the resource to
region str
The region of the resource
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The IP address
lbId String
The associated Load Balancer ID if any
organizationId String
The organization_id you want to attach the resource to
region String
The region of the resource

Look up Existing Ip Resource

Get an existing Ip 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?: IpState, opts?: CustomResourceOptions): Ip
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ip_address: Optional[str] = None,
        is_ipv6: Optional[bool] = None,
        lb_id: Optional[str] = None,
        organization_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        reverse: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        zone: Optional[str] = None) -> Ip
func GetIp(ctx *Context, name string, id IDInput, state *IpState, opts ...ResourceOption) (*Ip, error)
public static Ip Get(string name, Input<string> id, IpState? state, CustomResourceOptions? opts = null)
public static Ip get(String name, Output<String> id, IpState state, CustomResourceOptions options)
resources:  _:    type: scaleway:loadbalancers:Ip    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:
IpAddress string
The IP address
IsIpv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
LbId string
The associated Load Balancer ID if any
OrganizationId string
The organization_id you want to attach the resource to
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
Region string
The region of the resource
Reverse string
The reverse domain associated with this IP.
Tags List<string>
The tags associated with this IP.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
IpAddress string
The IP address
IsIpv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
LbId string
The associated Load Balancer ID if any
OrganizationId string
The organization_id you want to attach the resource to
ProjectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
Region string
The region of the resource
Reverse string
The reverse domain associated with this IP.
Tags []string
The tags associated with this IP.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
ipAddress String
The IP address
isIpv6 Changes to this property will trigger replacement. Boolean
If true, creates a flexible IP with an IPv6 address.
lbId String
The associated Load Balancer ID if any
organizationId String
The organization_id you want to attach the resource to
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the IP is associated with.
region String
The region of the resource
reverse String
The reverse domain associated with this IP.
tags List<String>
The tags associated with this IP.
zone Changes to this property will trigger replacement. String
zone) The zone in which the IP should be reserved.
ipAddress string
The IP address
isIpv6 Changes to this property will trigger replacement. boolean
If true, creates a flexible IP with an IPv6 address.
lbId string
The associated Load Balancer ID if any
organizationId string
The organization_id you want to attach the resource to
projectId Changes to this property will trigger replacement. string
project_id) The ID of the Project the IP is associated with.
region string
The region of the resource
reverse string
The reverse domain associated with this IP.
tags string[]
The tags associated with this IP.
zone Changes to this property will trigger replacement. string
zone) The zone in which the IP should be reserved.
ip_address str
The IP address
is_ipv6 Changes to this property will trigger replacement. bool
If true, creates a flexible IP with an IPv6 address.
lb_id str
The associated Load Balancer ID if any
organization_id str
The organization_id you want to attach the resource to
project_id Changes to this property will trigger replacement. str
project_id) The ID of the Project the IP is associated with.
region str
The region of the resource
reverse str
The reverse domain associated with this IP.
tags Sequence[str]
The tags associated with this IP.
zone Changes to this property will trigger replacement. str
zone) The zone in which the IP should be reserved.
ipAddress String
The IP address
isIpv6 Changes to this property will trigger replacement. Boolean
If true, creates a flexible IP with an IPv6 address.
lbId String
The associated Load Balancer ID if any
organizationId String
The organization_id you want to attach the resource to
projectId Changes to this property will trigger replacement. String
project_id) The ID of the Project the IP is associated with.
region String
The region of the resource
reverse String
The reverse domain associated with this IP.
tags List<String>
The tags associated with this IP.
zone Changes to this property will trigger replacement. String
zone) The zone in which the IP should be reserved.

Import

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

bash

$ pulumi import scaleway:loadbalancers/ip:Ip ip01 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