1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. Backend
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.LoadBalancer.Backend

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This resource provides the Backend resource in Oracle Cloud Infrastructure Load Balancer service.

    Adds a backend server to a backend set.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBackend = new oci.loadbalancer.Backend("test_backend", {
        backendsetName: testBackendSet.name,
        ipAddress: backendIpAddress,
        loadBalancerId: testLoadBalancer.id,
        port: backendPort,
        backup: backendBackup,
        drain: backendDrain,
        maxConnections: backendMaxConnections,
        offline: backendOffline,
        weight: backendWeight,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_backend = oci.load_balancer.Backend("test_backend",
        backendset_name=test_backend_set["name"],
        ip_address=backend_ip_address,
        load_balancer_id=test_load_balancer["id"],
        port=backend_port,
        backup=backend_backup,
        drain=backend_drain,
        max_connections=backend_max_connections,
        offline=backend_offline,
        weight=backend_weight)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/LoadBalancer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := LoadBalancer.NewBackend(ctx, "test_backend", &LoadBalancer.BackendArgs{
    			BackendsetName: pulumi.Any(testBackendSet.Name),
    			IpAddress:      pulumi.Any(backendIpAddress),
    			LoadBalancerId: pulumi.Any(testLoadBalancer.Id),
    			Port:           pulumi.Any(backendPort),
    			Backup:         pulumi.Any(backendBackup),
    			Drain:          pulumi.Any(backendDrain),
    			MaxConnections: pulumi.Any(backendMaxConnections),
    			Offline:        pulumi.Any(backendOffline),
    			Weight:         pulumi.Any(backendWeight),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testBackend = new Oci.LoadBalancer.Backend("test_backend", new()
        {
            BackendsetName = testBackendSet.Name,
            IpAddress = backendIpAddress,
            LoadBalancerId = testLoadBalancer.Id,
            Port = backendPort,
            Backup = backendBackup,
            Drain = backendDrain,
            MaxConnections = backendMaxConnections,
            Offline = backendOffline,
            Weight = backendWeight,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.LoadBalancer.Backend;
    import com.pulumi.oci.LoadBalancer.BackendArgs;
    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 testBackend = new Backend("testBackend", BackendArgs.builder()
                .backendsetName(testBackendSet.name())
                .ipAddress(backendIpAddress)
                .loadBalancerId(testLoadBalancer.id())
                .port(backendPort)
                .backup(backendBackup)
                .drain(backendDrain)
                .maxConnections(backendMaxConnections)
                .offline(backendOffline)
                .weight(backendWeight)
                .build());
    
        }
    }
    
    resources:
      testBackend:
        type: oci:LoadBalancer:Backend
        name: test_backend
        properties:
          backendsetName: ${testBackendSet.name}
          ipAddress: ${backendIpAddress}
          loadBalancerId: ${testLoadBalancer.id}
          port: ${backendPort}
          backup: ${backendBackup}
          drain: ${backendDrain}
          maxConnections: ${backendMaxConnections}
          offline: ${backendOffline}
          weight: ${backendWeight}
    

    Create Backend Resource

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

    Constructor syntax

    new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
    @overload
    def Backend(resource_name: str,
                args: BackendArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                backendset_name: Optional[str] = None,
                ip_address: Optional[str] = None,
                load_balancer_id: Optional[str] = None,
                port: Optional[int] = None,
                backup: Optional[bool] = None,
                drain: Optional[bool] = None,
                max_connections: Optional[int] = None,
                offline: Optional[bool] = None,
                weight: Optional[int] = None)
    func NewBackend(ctx *Context, name string, args BackendArgs, opts ...ResourceOption) (*Backend, error)
    public Backend(string name, BackendArgs args, CustomResourceOptions? opts = null)
    public Backend(String name, BackendArgs args)
    public Backend(String name, BackendArgs args, CustomResourceOptions options)
    
    type: oci:LoadBalancer:Backend
    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 BackendArgs
    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 BackendArgs
    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 BackendArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var backendResource = new Oci.LoadBalancer.Backend("backendResource", new()
    {
        BackendsetName = "string",
        IpAddress = "string",
        LoadBalancerId = "string",
        Port = 0,
        Backup = false,
        Drain = false,
        MaxConnections = 0,
        Offline = false,
        Weight = 0,
    });
    
    example, err := LoadBalancer.NewBackend(ctx, "backendResource", &LoadBalancer.BackendArgs{
    	BackendsetName: pulumi.String("string"),
    	IpAddress:      pulumi.String("string"),
    	LoadBalancerId: pulumi.String("string"),
    	Port:           pulumi.Int(0),
    	Backup:         pulumi.Bool(false),
    	Drain:          pulumi.Bool(false),
    	MaxConnections: pulumi.Int(0),
    	Offline:        pulumi.Bool(false),
    	Weight:         pulumi.Int(0),
    })
    
    var backendResource = new Backend("backendResource", BackendArgs.builder()
        .backendsetName("string")
        .ipAddress("string")
        .loadBalancerId("string")
        .port(0)
        .backup(false)
        .drain(false)
        .maxConnections(0)
        .offline(false)
        .weight(0)
        .build());
    
    backend_resource = oci.load_balancer.Backend("backendResource",
        backendset_name="string",
        ip_address="string",
        load_balancer_id="string",
        port=0,
        backup=False,
        drain=False,
        max_connections=0,
        offline=False,
        weight=0)
    
    const backendResource = new oci.loadbalancer.Backend("backendResource", {
        backendsetName: "string",
        ipAddress: "string",
        loadBalancerId: "string",
        port: 0,
        backup: false,
        drain: false,
        maxConnections: 0,
        offline: false,
        weight: 0,
    });
    
    type: oci:LoadBalancer:Backend
    properties:
        backendsetName: string
        backup: false
        drain: false
        ipAddress: string
        loadBalancerId: string
        maxConnections: 0
        offline: false
        port: 0
        weight: 0
    

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

    BackendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    LoadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    Port int
    The communication port for the backend server. Example: 8080
    Backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    Drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    MaxConnections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    Offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    BackendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    LoadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    Port int
    The communication port for the backend server. Example: 8080
    Backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    Drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    MaxConnections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    Offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName String
    The name of the backend set to add the backend server to. Example: example_backend_set
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId String
    The OCID of the load balancer associated with the backend set and servers.
    port Integer
    The communication port for the backend server. Example: 8080
    backup Boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain Boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    maxConnections Integer
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    offline Boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    weight Integer

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    port number
    The communication port for the backend server. Example: 8080
    backup boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    maxConnections number
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    offline boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    weight number

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendset_name str
    The name of the backend set to add the backend server to. Example: example_backend_set
    ip_address str
    The IP address of the backend server. Example: 10.0.0.3
    load_balancer_id str
    The OCID of the load balancer associated with the backend set and servers.
    port int
    The communication port for the backend server. Example: 8080
    backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    max_connections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName String
    The name of the backend set to add the backend server to. Example: example_backend_set
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId String
    The OCID of the load balancer associated with the backend set and servers.
    port Number
    The communication port for the backend server. Example: 8080
    backup Boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain Boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    maxConnections Number
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    offline Boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    weight Number

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    State string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    State string
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    state String
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    state string
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    state str
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    state String

    Look up Existing Backend Resource

    Get an existing Backend 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?: BackendState, opts?: CustomResourceOptions): Backend
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backendset_name: Optional[str] = None,
            backup: Optional[bool] = None,
            drain: Optional[bool] = None,
            ip_address: Optional[str] = None,
            load_balancer_id: Optional[str] = None,
            max_connections: Optional[int] = None,
            name: Optional[str] = None,
            offline: Optional[bool] = None,
            port: Optional[int] = None,
            state: Optional[str] = None,
            weight: Optional[int] = None) -> Backend
    func GetBackend(ctx *Context, name string, id IDInput, state *BackendState, opts ...ResourceOption) (*Backend, error)
    public static Backend Get(string name, Input<string> id, BackendState? state, CustomResourceOptions? opts = null)
    public static Backend get(String name, Output<String> id, BackendState 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:
    BackendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    Backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    Drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    LoadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    MaxConnections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    Name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    Offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Port int
    The communication port for the backend server. Example: 8080
    State string
    Weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    BackendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    Backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    Drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    LoadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    MaxConnections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    Name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    Offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Port int
    The communication port for the backend server. Example: 8080
    State string
    Weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName String
    The name of the backend set to add the backend server to. Example: example_backend_set
    backup Boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain Boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId String
    The OCID of the load balancer associated with the backend set and servers.
    maxConnections Integer
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    name String
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    offline Boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    port Integer
    The communication port for the backend server. Example: 8080
    state String
    weight Integer

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName string
    The name of the backend set to add the backend server to. Example: example_backend_set
    backup boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId string
    The OCID of the load balancer associated with the backend set and servers.
    maxConnections number
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    name string
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    offline boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    port number
    The communication port for the backend server. Example: 8080
    state string
    weight number

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendset_name str
    The name of the backend set to add the backend server to. Example: example_backend_set
    backup bool

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain bool
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    ip_address str
    The IP address of the backend server. Example: 10.0.0.3
    load_balancer_id str
    The OCID of the load balancer associated with the backend set and servers.
    max_connections int
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    name str
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    offline bool
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    port int
    The communication port for the backend server. Example: 8080
    state str
    weight int

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    backendsetName String
    The name of the backend set to add the backend server to. Example: example_backend_set
    backup Boolean

    (Updatable) Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.

    Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    Example: false

    drain Boolean
    (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    loadBalancerId String
    The OCID of the load balancer associated with the backend set and servers.
    maxConnections Number
    (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
    name String
    A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080
    offline Boolean
    (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    port Number
    The communication port for the backend server. Example: 8080
    state String
    weight Number

    (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    Backends can be imported using the id, e.g.

    $ pulumi import oci:LoadBalancer/backend:Backend test_backend "loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi