ovh.IpLoadBalancing.TcpRoute

Manage TCP route for a loadbalancer service

Example Usage

using System.Collections.Generic;
using Pulumi;
using Ovh = Lbrlabs.PulumiPackage.Ovh;

return await Deployment.RunAsync(() => 
{
    var tcpreject = new Ovh.IpLoadBalancing.TcpRoute("tcpreject", new()
    {
        Action = new Ovh.IpLoadBalancing.Inputs.TcpRouteActionArgs
        {
            Type = "reject",
        },
        ServiceName = "loadbalancer-xxxxxxxxxxxxxxxxxx",
        Weight = 1,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := IpLoadBalancing.NewTcpRoute(ctx, "tcpreject", &IpLoadBalancing.TcpRouteArgs{
			Action: &iploadbalancing.TcpRouteActionArgs{
				Type: pulumi.String("reject"),
			},
			ServiceName: pulumi.String("loadbalancer-xxxxxxxxxxxxxxxxxx"),
			Weight:      pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.IpLoadBalancing.TcpRoute;
import com.pulumi.ovh.IpLoadBalancing.TcpRouteArgs;
import com.pulumi.ovh.IpLoadBalancing.inputs.TcpRouteActionArgs;
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 tcpreject = new TcpRoute("tcpreject", TcpRouteArgs.builder()        
            .action(TcpRouteActionArgs.builder()
                .type("reject")
                .build())
            .serviceName("loadbalancer-xxxxxxxxxxxxxxxxxx")
            .weight(1)
            .build());

    }
}
import pulumi
import lbrlabs_pulumi_ovh as ovh

tcpreject = ovh.ip_load_balancing.TcpRoute("tcpreject",
    action=ovh.ip_load_balancing.TcpRouteActionArgs(
        type="reject",
    ),
    service_name="loadbalancer-xxxxxxxxxxxxxxxxxx",
    weight=1)
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@lbrlabs/pulumi-ovh";

const tcpreject = new ovh.iploadbalancing.TcpRoute("tcpreject", {
    action: {
        type: "reject",
    },
    serviceName: "loadbalancer-xxxxxxxxxxxxxxxxxx",
    weight: 1,
});
resources:
  tcpreject:
    type: ovh:IpLoadBalancing:TcpRoute
    properties:
      action:
        type: reject
      serviceName: loadbalancer-xxxxxxxxxxxxxxxxxx
      weight: 1

Create TcpRoute Resource

new TcpRoute(name: string, args: TcpRouteArgs, opts?: CustomResourceOptions);
@overload
def TcpRoute(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             action: Optional[_iploadbalancing.TcpRouteActionArgs] = None,
             display_name: Optional[str] = None,
             frontend_id: Optional[int] = None,
             service_name: Optional[str] = None,
             weight: Optional[int] = None)
@overload
def TcpRoute(resource_name: str,
             args: TcpRouteArgs,
             opts: Optional[ResourceOptions] = None)
func NewTcpRoute(ctx *Context, name string, args TcpRouteArgs, opts ...ResourceOption) (*TcpRoute, error)
public TcpRoute(string name, TcpRouteArgs args, CustomResourceOptions? opts = null)
public TcpRoute(String name, TcpRouteArgs args)
public TcpRoute(String name, TcpRouteArgs args, CustomResourceOptions options)
type: ovh:IpLoadBalancing:TcpRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args TcpRouteArgs
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 TcpRouteArgs
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 TcpRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TcpRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TcpRouteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TcpRoute Resource Properties

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

Inputs

The TcpRoute resource accepts the following input properties:

Action Lbrlabs.PulumiPackage.Ovh.IpLoadBalancing.Inputs.TcpRouteActionArgs

Action triggered when all rules match

ServiceName string

The internal name of your IP load balancing

DisplayName string

Human readable name for your route, this field is for you

FrontendId int

Route traffic for this frontend

Weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

Action TcpRouteActionArgs

Action triggered when all rules match

ServiceName string

The internal name of your IP load balancing

DisplayName string

Human readable name for your route, this field is for you

FrontendId int

Route traffic for this frontend

Weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

serviceName String

The internal name of your IP load balancing

displayName String

Human readable name for your route, this field is for you

frontendId Integer

Route traffic for this frontend

weight Integer

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

serviceName string

The internal name of your IP load balancing

displayName string

Human readable name for your route, this field is for you

frontendId number

Route traffic for this frontend

weight number

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

service_name str

The internal name of your IP load balancing

display_name str

Human readable name for your route, this field is for you

frontend_id int

Route traffic for this frontend

weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action Property Map

Action triggered when all rules match

serviceName String

The internal name of your IP load balancing

displayName String

Human readable name for your route, this field is for you

frontendId Number

Route traffic for this frontend

weight Number

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Rules List<Lbrlabs.PulumiPackage.Ovh.IpLoadBalancing.Outputs.TcpRouteRule>

List of rules to match to trigger action

Status string

Route status. Routes in "ok" state are ready to operate

Id string

The provider-assigned unique ID for this managed resource.

Rules []TcpRouteRuleType

List of rules to match to trigger action

Status string

Route status. Routes in "ok" state are ready to operate

id String

The provider-assigned unique ID for this managed resource.

rules List<TcpRouteRule>

List of rules to match to trigger action

status String

Route status. Routes in "ok" state are ready to operate

id string

The provider-assigned unique ID for this managed resource.

rules TcpRouteRule[]

List of rules to match to trigger action

status string

Route status. Routes in "ok" state are ready to operate

id str

The provider-assigned unique ID for this managed resource.

rules TcpRouteRule]

List of rules to match to trigger action

status str

Route status. Routes in "ok" state are ready to operate

id String

The provider-assigned unique ID for this managed resource.

rules List<Property Map>

List of rules to match to trigger action

status String

Route status. Routes in "ok" state are ready to operate

Look up Existing TcpRoute Resource

Get an existing TcpRoute 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?: TcpRouteState, opts?: CustomResourceOptions): TcpRoute
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[_iploadbalancing.TcpRouteActionArgs] = None,
        display_name: Optional[str] = None,
        frontend_id: Optional[int] = None,
        rules: Optional[Sequence[_iploadbalancing.TcpRouteRuleArgs]] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        weight: Optional[int] = None) -> TcpRoute
func GetTcpRoute(ctx *Context, name string, id IDInput, state *TcpRouteState, opts ...ResourceOption) (*TcpRoute, error)
public static TcpRoute Get(string name, Input<string> id, TcpRouteState? state, CustomResourceOptions? opts = null)
public static TcpRoute get(String name, Output<String> id, TcpRouteState 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:
Action Lbrlabs.PulumiPackage.Ovh.IpLoadBalancing.Inputs.TcpRouteActionArgs

Action triggered when all rules match

DisplayName string

Human readable name for your route, this field is for you

FrontendId int

Route traffic for this frontend

Rules List<Lbrlabs.PulumiPackage.Ovh.IpLoadBalancing.Inputs.TcpRouteRuleArgs>

List of rules to match to trigger action

ServiceName string

The internal name of your IP load balancing

Status string

Route status. Routes in "ok" state are ready to operate

Weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

Action TcpRouteActionArgs

Action triggered when all rules match

DisplayName string

Human readable name for your route, this field is for you

FrontendId int

Route traffic for this frontend

Rules []TcpRouteRuleTypeArgs

List of rules to match to trigger action

ServiceName string

The internal name of your IP load balancing

Status string

Route status. Routes in "ok" state are ready to operate

Weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

displayName String

Human readable name for your route, this field is for you

frontendId Integer

Route traffic for this frontend

rules List<TcpRouteRuleArgs>

List of rules to match to trigger action

serviceName String

The internal name of your IP load balancing

status String

Route status. Routes in "ok" state are ready to operate

weight Integer

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

displayName string

Human readable name for your route, this field is for you

frontendId number

Route traffic for this frontend

rules TcpRouteRuleArgs[]

List of rules to match to trigger action

serviceName string

The internal name of your IP load balancing

status string

Route status. Routes in "ok" state are ready to operate

weight number

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action TcpRouteActionArgs

Action triggered when all rules match

display_name str

Human readable name for your route, this field is for you

frontend_id int

Route traffic for this frontend

rules TcpRouteRuleArgs]

List of rules to match to trigger action

service_name str

The internal name of your IP load balancing

status str

Route status. Routes in "ok" state are ready to operate

weight int

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

action Property Map

Action triggered when all rules match

displayName String

Human readable name for your route, this field is for you

frontendId Number

Route traffic for this frontend

rules List<Property Map>

List of rules to match to trigger action

serviceName String

The internal name of your IP load balancing

status String

Route status. Routes in "ok" state are ready to operate

weight Number

Route priority ([0..255]). 0 if null. Highest priority routes are evaluated first. Only the first matching route will trigger an action

Supporting Types

TcpRouteAction

Type string

Action to trigger if all the rules of this route matches

Target string

Farm ID for "farm" action type, empty for others.

Type string

Action to trigger if all the rules of this route matches

Target string

Farm ID for "farm" action type, empty for others.

type String

Action to trigger if all the rules of this route matches

target String

Farm ID for "farm" action type, empty for others.

type string

Action to trigger if all the rules of this route matches

target string

Farm ID for "farm" action type, empty for others.

type str

Action to trigger if all the rules of this route matches

target str

Farm ID for "farm" action type, empty for others.

type String

Action to trigger if all the rules of this route matches

target String

Farm ID for "farm" action type, empty for others.

TcpRouteRule

Field string

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

Match string

Matching operator. Not all operators are available for all fields. See "availableRules"

Negate bool

Invert the matching operator effect

Pattern string

Value to match against this match. Interpretation if this field depends on the match and field

RuleId int

Id of your rule

SubField string

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

Field string

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

Match string

Matching operator. Not all operators are available for all fields. See "availableRules"

Negate bool

Invert the matching operator effect

Pattern string

Value to match against this match. Interpretation if this field depends on the match and field

RuleId int

Id of your rule

SubField string

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

field String

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

match String

Matching operator. Not all operators are available for all fields. See "availableRules"

negate Boolean

Invert the matching operator effect

pattern String

Value to match against this match. Interpretation if this field depends on the match and field

ruleId Integer

Id of your rule

subField String

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

field string

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

match string

Matching operator. Not all operators are available for all fields. See "availableRules"

negate boolean

Invert the matching operator effect

pattern string

Value to match against this match. Interpretation if this field depends on the match and field

ruleId number

Id of your rule

subField string

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

field str

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

match str

Matching operator. Not all operators are available for all fields. See "availableRules"

negate bool

Invert the matching operator effect

pattern str

Value to match against this match. Interpretation if this field depends on the match and field

rule_id int

Id of your rule

sub_field str

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

field String

Name of the field to match like "protocol" or "host" "/ipLoadbalancing/{serviceName}/route/availableRules" for a list of available rules

match String

Matching operator. Not all operators are available for all fields. See "availableRules"

negate Boolean

Invert the matching operator effect

pattern String

Value to match against this match. Interpretation if this field depends on the match and field

ruleId Number

Id of your rule

subField String

Name of sub-field, if applicable. This may be a Cookie or Header name for instance

Package Details

Repository
ovh lbrlabs/pulumi-ovh
License
Apache-2.0
Notes

This Pulumi package is based on the ovh Terraform Provider.