Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. LoadbalancerIp
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.LoadbalancerIp

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 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.LoadbalancerIp("ip", {reverse: "my-reverse.com"});

    import pulumi
import pulumiverse_scaleway as scaleway

ip = scaleway.LoadbalancerIp("ip", reverse="my-reverse.com")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.NewLoadbalancerIp(ctx, "ip", &scaleway.LoadbalancerIpArgs{
			Reverse: pulumi.String("my-reverse.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var ip = new Scaleway.LoadbalancerIp("ip", new()
    {
        Reverse = "my-reverse.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.LoadbalancerIp;
import com.pulumi.scaleway.LoadbalancerIpArgs;
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 LoadbalancerIp("ip", LoadbalancerIpArgs.builder()
            .reverse("my-reverse.com")
            .build());

    }
}

    resources:
  ip:
    type: scaleway:LoadbalancerIp
    properties:
      reverse: my-reverse.com

    With IPv6

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

const ipv6 = new scaleway.LoadbalancerIp("ipv6", {isIpv6: true});

    import pulumi
import pulumiverse_scaleway as scaleway

ipv6 = scaleway.LoadbalancerIp("ipv6", is_ipv6=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.NewLoadbalancerIp(ctx, "ipv6", &scaleway.LoadbalancerIpArgs{
			IsIpv6: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var ipv6 = new Scaleway.LoadbalancerIp("ipv6", new()
    {
        IsIpv6 = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.LoadbalancerIp;
import com.pulumi.scaleway.LoadbalancerIpArgs;
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 LoadbalancerIp("ipv6", LoadbalancerIpArgs.builder()
            .isIpv6(true)
            .build());

    }
}

    resources:
  ipv6:
    type: scaleway:LoadbalancerIp
    properties:
      isIpv6: true

    Create LoadbalancerIp Resource

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

    Constructor syntax

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

@overload
def LoadbalancerIp(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 NewLoadbalancerIp(ctx *Context, name string, args *LoadbalancerIpArgs, opts ...ResourceOption) (*LoadbalancerIp, error)
    public LoadbalancerIp(string name, LoadbalancerIpArgs? args = null, CustomResourceOptions? opts = null)
    public LoadbalancerIp(String name, LoadbalancerIpArgs args)
public LoadbalancerIp(String name, LoadbalancerIpArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args LoadbalancerIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LoadbalancerIpArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LoadbalancerIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadbalancerIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadbalancerIpArgs
    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 loadbalancerIpResource = new Scaleway.LoadbalancerIp("loadbalancerIpResource", new()
{
    IsIpv6 = false,
    ProjectId = "string",
    Reverse = "string",
    Tags = new[]
    {
        "string",
    },
    Zone = "string",
});

    example, err := scaleway.NewLoadbalancerIp(ctx, "loadbalancerIpResource", &scaleway.LoadbalancerIpArgs{
	IsIpv6:    pulumi.Bool(false),
	ProjectId: pulumi.String("string"),
	Reverse:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})

    var loadbalancerIpResource = new LoadbalancerIp("loadbalancerIpResource", LoadbalancerIpArgs.builder()
    .isIpv6(false)
    .projectId("string")
    .reverse("string")
    .tags("string")
    .zone("string")
    .build());

    loadbalancer_ip_resource = scaleway.LoadbalancerIp("loadbalancerIpResource",
    is_ipv6=False,
    project_id="string",
    reverse="string",
    tags=["string"],
    zone="string")

    const loadbalancerIpResource = new scaleway.LoadbalancerIp("loadbalancerIpResource", {
    isIpv6: false,
    projectId: "string",
    reverse: "string",
    tags: ["string"],
    zone: "string",
});

    type: scaleway:LoadbalancerIp
properties:
    isIpv6: false
    projectId: string
    reverse: string
    tags:
        - string
    zone: string

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

    IsIpv6 bool
    If true, creates a flexible IP with an IPv6 address.
    ProjectId 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 string
    zone) The zone in which the IP should be reserved.
    IsIpv6 bool
    If true, creates a flexible IP with an IPv6 address.
    ProjectId 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 string
    zone) The zone in which the IP should be reserved.
    isIpv6 Boolean
    If true, creates a flexible IP with an IPv6 address.
    projectId 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 String
    zone) The zone in which the IP should be reserved.
    isIpv6 boolean
    If true, creates a flexible IP with an IPv6 address.
    projectId 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 string
    zone) The zone in which the IP should be reserved.
    is_ipv6 bool
    If true, creates a flexible IP with an IPv6 address.
    project_id 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 str
    zone) The zone in which the IP should be reserved.
    isIpv6 Boolean
    If true, creates a flexible IP with an IPv6 address.
    projectId 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 String
    zone) The zone in which the IP should be reserved.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadbalancerIp 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 LoadbalancerIp Resource

    Get an existing LoadbalancerIp 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?: LoadbalancerIpState, opts?: CustomResourceOptions): LoadbalancerIp
    @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) -> LoadbalancerIp
    func GetLoadbalancerIp(ctx *Context, name string, id IDInput, state *LoadbalancerIpState, opts ...ResourceOption) (*LoadbalancerIp, error)
    public static LoadbalancerIp Get(string name, Input<string> id, LoadbalancerIpState? state, CustomResourceOptions? opts = null)
    public static LoadbalancerIp get(String name, Output<String> id, LoadbalancerIpState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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 string
    zone) The zone in which the IP should be reserved.
    IpAddress string
    The IP address
    IsIpv6 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 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 string
    zone) The zone in which the IP should be reserved.
    ipAddress String
    The IP address
    isIpv6 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 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 String
    zone) The zone in which the IP should be reserved.
    ipAddress string
    The IP address
    isIpv6 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 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 string
    zone) The zone in which the IP should be reserved.
    ip_address str
    The IP address
    is_ipv6 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 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 str
    zone) The zone in which the IP should be reserved.
    ipAddress String
    The IP address
    isIpv6 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 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 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:index/loadbalancerIp:LoadbalancerIp ip01 fr-par-1/11111111-1111-1111-1111-111111111111

    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 logo
    Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
    pulumiverse/pulumi-scaleway