Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. IpLoadBalancing
  5. UdpFrontend
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.IpLoadBalancing.UdpFrontend

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

    Creates a backend server group (frontend) to be used by loadbalancing frontend(s)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";
import * as ovh from "@pulumi/ovh";

const lb = ovh.IpLoadBalancing.getIpLoadBalancing({
    serviceName: "ip-1.2.3.4",
    state: "ok",
});
const testfrontend = new ovh.iploadbalancing.UdpFrontend("testfrontend", {
    serviceName: lb.then(lb => lb.serviceName),
    displayName: "ingress-8080-gra",
    zone: "all",
    port: "10,11",
});

    import pulumi
import pulumi_ovh as ovh

lb = ovh.IpLoadBalancing.get_ip_load_balancing(service_name="ip-1.2.3.4",
    state="ok")
testfrontend = ovh.ip_load_balancing.UdpFrontend("testfrontend",
    service_name=lb.service_name,
    display_name="ingress-8080-gra",
    zone="all",
    port="10,11")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/go/ovh/IpLoadBalancing"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		lb, err := IpLoadBalancing.GetIpLoadBalancing(ctx, &iploadbalancing.GetIpLoadBalancingArgs{
			ServiceName: pulumi.StringRef("ip-1.2.3.4"),
			State:       pulumi.StringRef("ok"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = IpLoadBalancing.NewUdpFrontend(ctx, "testfrontend", &IpLoadBalancing.UdpFrontendArgs{
			ServiceName: pulumi.String(lb.ServiceName),
			DisplayName: pulumi.String("ingress-8080-gra"),
			Zone:        pulumi.String("all"),
			Port:        pulumi.String("10,11"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var lb = Ovh.IpLoadBalancing.GetIpLoadBalancing.Invoke(new()
    {
        ServiceName = "ip-1.2.3.4",
        State = "ok",
    });

    var testfrontend = new Ovh.IpLoadBalancing.UdpFrontend("testfrontend", new()
    {
        ServiceName = lb.Apply(getIpLoadBalancingResult => getIpLoadBalancingResult.ServiceName),
        DisplayName = "ingress-8080-gra",
        Zone = "all",
        Port = "10,11",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.IpLoadBalancing.IpLoadBalancingFunctions;
import com.pulumi.ovh.IpLoadBalancing.inputs.GetIpLoadBalancingArgs;
import com.pulumi.ovh.IpLoadBalancing.UdpFrontend;
import com.pulumi.ovh.IpLoadBalancing.UdpFrontendArgs;
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) {
        final var lb = IpLoadBalancingFunctions.getIpLoadBalancing(GetIpLoadBalancingArgs.builder()
            .serviceName("ip-1.2.3.4")
            .state("ok")
            .build());

        var testfrontend = new UdpFrontend("testfrontend", UdpFrontendArgs.builder()
            .serviceName(lb.applyValue(getIpLoadBalancingResult -> getIpLoadBalancingResult.serviceName()))
            .displayName("ingress-8080-gra")
            .zone("all")
            .port("10,11")
            .build());

    }
}

    resources:
  testfrontend:
    type: ovh:IpLoadBalancing:UdpFrontend
    properties:
      serviceName: ${lb.serviceName}
      displayName: ingress-8080-gra
      zone: all
      port: 10,11
variables:
  lb:
    fn::invoke:
      Function: ovh:IpLoadBalancing:getIpLoadBalancing
      Arguments:
        serviceName: ip-1.2.3.4
        state: ok

    Create UdpFrontend Resource

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

    Constructor syntax

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

@overload
def UdpFrontend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                port: Optional[str] = None,
                service_name: Optional[str] = None,
                zone: Optional[str] = None,
                dedicated_ipfos: Optional[Sequence[str]] = None,
                default_farm_id: Optional[float] = None,
                disabled: Optional[bool] = None,
                display_name: Optional[str] = None)
    func NewUdpFrontend(ctx *Context, name string, args UdpFrontendArgs, opts ...ResourceOption) (*UdpFrontend, error)
    public UdpFrontend(string name, UdpFrontendArgs args, CustomResourceOptions? opts = null)
    public UdpFrontend(String name, UdpFrontendArgs args)
public UdpFrontend(String name, UdpFrontendArgs args, CustomResourceOptions options)

    type: ovh:IpLoadBalancing:UdpFrontend
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 UdpFrontendArgs
    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 UdpFrontendArgs
    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 UdpFrontendArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UdpFrontendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UdpFrontendArgs
    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 udpFrontendResource = new Ovh.IpLoadBalancing.UdpFrontend("udpFrontendResource", new()
{
    Port = "string",
    ServiceName = "string",
    Zone = "string",
    DedicatedIpfos = new[]
    {
        "string",
    },
    DefaultFarmId = 0,
    Disabled = false,
    DisplayName = "string",
});

    example, err := IpLoadBalancing.NewUdpFrontend(ctx, "udpFrontendResource", &IpLoadBalancing.UdpFrontendArgs{
	Port:        pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Zone:        pulumi.String("string"),
	DedicatedIpfos: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefaultFarmId: pulumi.Float64(0),
	Disabled:      pulumi.Bool(false),
	DisplayName:   pulumi.String("string"),
})

    var udpFrontendResource = new UdpFrontend("udpFrontendResource", UdpFrontendArgs.builder()
    .port("string")
    .serviceName("string")
    .zone("string")
    .dedicatedIpfos("string")
    .defaultFarmId(0)
    .disabled(false)
    .displayName("string")
    .build());

    udp_frontend_resource = ovh.ip_load_balancing.UdpFrontend("udpFrontendResource",
    port="string",
    service_name="string",
    zone="string",
    dedicated_ipfos=["string"],
    default_farm_id=0,
    disabled=False,
    display_name="string")

    const udpFrontendResource = new ovh.iploadbalancing.UdpFrontend("udpFrontendResource", {
    port: "string",
    serviceName: "string",
    zone: "string",
    dedicatedIpfos: ["string"],
    defaultFarmId: 0,
    disabled: false,
    displayName: "string",
});

    type: ovh:IpLoadBalancing:UdpFrontend
properties:
    dedicatedIpfos:
        - string
    defaultFarmId: 0
    disabled: false
    displayName: string
    port: string
    serviceName: string
    zone: string

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

    Port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    ServiceName string
    The internal name of your IP load balancing
    Zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    DedicatedIpfos List<string>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    DefaultFarmId double
    Default UDP Farm of your frontend
    Disabled bool
    Disable your frontend. Default: 'false'
    DisplayName string
    Human readable name for your frontend
    Port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    ServiceName string
    The internal name of your IP load balancing
    Zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    DedicatedIpfos []string
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    DefaultFarmId float64
    Default UDP Farm of your frontend
    Disabled bool
    Disable your frontend. Default: 'false'
    DisplayName string
    Human readable name for your frontend
    port String
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName String
    The internal name of your IP load balancing
    zone String
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos List<String>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId Double
    Default UDP Farm of your frontend
    disabled Boolean
    Disable your frontend. Default: 'false'
    displayName String
    Human readable name for your frontend
    port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName string
    The internal name of your IP load balancing
    zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos string[]
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId number
    Default UDP Farm of your frontend
    disabled boolean
    Disable your frontend. Default: 'false'
    displayName string
    Human readable name for your frontend
    port str
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    service_name str
    The internal name of your IP load balancing
    zone str
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicated_ipfos Sequence[str]
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    default_farm_id float
    Default UDP Farm of your frontend
    disabled bool
    Disable your frontend. Default: 'false'
    display_name str
    Human readable name for your frontend
    port String
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName String
    The internal name of your IP load balancing
    zone String
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos List<String>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId Number
    Default UDP Farm of your frontend
    disabled Boolean
    Disable your frontend. Default: 'false'
    displayName String
    Human readable name for your frontend

    Outputs

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

    FrontendId double
    Id of your frontend
    Id string
    The provider-assigned unique ID for this managed resource.
    FrontendId float64
    Id of your frontend
    Id string
    The provider-assigned unique ID for this managed resource.
    frontendId Double
    Id of your frontend
    id String
    The provider-assigned unique ID for this managed resource.
    frontendId number
    Id of your frontend
    id string
    The provider-assigned unique ID for this managed resource.
    frontend_id float
    Id of your frontend
    id str
    The provider-assigned unique ID for this managed resource.
    frontendId Number
    Id of your frontend
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UdpFrontend Resource

    Get an existing UdpFrontend 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?: UdpFrontendState, opts?: CustomResourceOptions): UdpFrontend
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dedicated_ipfos: Optional[Sequence[str]] = None,
        default_farm_id: Optional[float] = None,
        disabled: Optional[bool] = None,
        display_name: Optional[str] = None,
        frontend_id: Optional[float] = None,
        port: Optional[str] = None,
        service_name: Optional[str] = None,
        zone: Optional[str] = None) -> UdpFrontend
    func GetUdpFrontend(ctx *Context, name string, id IDInput, state *UdpFrontendState, opts ...ResourceOption) (*UdpFrontend, error)
    public static UdpFrontend Get(string name, Input<string> id, UdpFrontendState? state, CustomResourceOptions? opts = null)
    public static UdpFrontend get(String name, Output<String> id, UdpFrontendState 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:
    DedicatedIpfos List<string>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    DefaultFarmId double
    Default UDP Farm of your frontend
    Disabled bool
    Disable your frontend. Default: 'false'
    DisplayName string
    Human readable name for your frontend
    FrontendId double
    Id of your frontend
    Port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    ServiceName string
    The internal name of your IP load balancing
    Zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    DedicatedIpfos []string
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    DefaultFarmId float64
    Default UDP Farm of your frontend
    Disabled bool
    Disable your frontend. Default: 'false'
    DisplayName string
    Human readable name for your frontend
    FrontendId float64
    Id of your frontend
    Port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    ServiceName string
    The internal name of your IP load balancing
    Zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos List<String>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId Double
    Default UDP Farm of your frontend
    disabled Boolean
    Disable your frontend. Default: 'false'
    displayName String
    Human readable name for your frontend
    frontendId Double
    Id of your frontend
    port String
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName String
    The internal name of your IP load balancing
    zone String
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos string[]
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId number
    Default UDP Farm of your frontend
    disabled boolean
    Disable your frontend. Default: 'false'
    displayName string
    Human readable name for your frontend
    frontendId number
    Id of your frontend
    port string
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName string
    The internal name of your IP load balancing
    zone string
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicated_ipfos Sequence[str]
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    default_farm_id float
    Default UDP Farm of your frontend
    disabled bool
    Disable your frontend. Default: 'false'
    display_name str
    Human readable name for your frontend
    frontend_id float
    Id of your frontend
    port str
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    service_name str
    The internal name of your IP load balancing
    zone str
    Zone where the frontend will be defined (ie. gra, bhs also supports all)
    dedicatedIpfos List<String>
    Only attach frontend on these ip. No restriction if null. List of Ip blocks.
    defaultFarmId Number
    Default UDP Farm of your frontend
    disabled Boolean
    Disable your frontend. Default: 'false'
    displayName String
    Human readable name for your frontend
    frontendId Number
    Id of your frontend
    port String
    Port(s) attached to your frontend. Supports single port (numerical value), range (2 dash-delimited increasing ports) and comma-separated list of 'single port' and/or 'range'. Each port must be in the [1;49151] range
    serviceName String
    The internal name of your IP load balancing
    zone String
    Zone where the frontend will be defined (ie. gra, bhs also supports all)

    Import

    UDP frontend can be imported using the following format service_name and the id of the frontend separated by “/” e.g.

    bash

    $ pulumi import ovh:IpLoadBalancing/udpFrontend:UdpFrontend testfrontend service_name/frontend_id

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

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
    ovh/pulumi-ovh