1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. Backend
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.NetworkLoadBalancer.Backend

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    This resource provides the Backend resource in Oracle Cloud Infrastructure Network 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.networkloadbalancer.Backend("test_backend", {
        backendSetName: testBackendSet.name,
        networkLoadBalancerId: testNetworkLoadBalancer.id,
        port: backendPort,
        ipAddress: backendIpAddress,
        isBackup: backendIsBackup,
        isDrain: backendIsDrain,
        isOffline: backendIsOffline,
        name: backendName,
        targetId: testTarget.id,
        weight: backendWeight,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_backend = oci.network_load_balancer.Backend("test_backend",
        backend_set_name=test_backend_set["name"],
        network_load_balancer_id=test_network_load_balancer["id"],
        port=backend_port,
        ip_address=backend_ip_address,
        is_backup=backend_is_backup,
        is_drain=backend_is_drain,
        is_offline=backend_is_offline,
        name=backend_name,
        target_id=test_target["id"],
        weight=backend_weight)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/NetworkLoadBalancer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := NetworkLoadBalancer.NewBackend(ctx, "test_backend", &NetworkLoadBalancer.BackendArgs{
    			BackendSetName:        pulumi.Any(testBackendSet.Name),
    			NetworkLoadBalancerId: pulumi.Any(testNetworkLoadBalancer.Id),
    			Port:                  pulumi.Any(backendPort),
    			IpAddress:             pulumi.Any(backendIpAddress),
    			IsBackup:              pulumi.Any(backendIsBackup),
    			IsDrain:               pulumi.Any(backendIsDrain),
    			IsOffline:             pulumi.Any(backendIsOffline),
    			Name:                  pulumi.Any(backendName),
    			TargetId:              pulumi.Any(testTarget.Id),
    			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.NetworkLoadBalancer.Backend("test_backend", new()
        {
            BackendSetName = testBackendSet.Name,
            NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
            Port = backendPort,
            IpAddress = backendIpAddress,
            IsBackup = backendIsBackup,
            IsDrain = backendIsDrain,
            IsOffline = backendIsOffline,
            Name = backendName,
            TargetId = testTarget.Id,
            Weight = backendWeight,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.NetworkLoadBalancer.Backend;
    import com.pulumi.oci.NetworkLoadBalancer.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())
                .networkLoadBalancerId(testNetworkLoadBalancer.id())
                .port(backendPort)
                .ipAddress(backendIpAddress)
                .isBackup(backendIsBackup)
                .isDrain(backendIsDrain)
                .isOffline(backendIsOffline)
                .name(backendName)
                .targetId(testTarget.id())
                .weight(backendWeight)
                .build());
    
        }
    }
    
    resources:
      testBackend:
        type: oci:NetworkLoadBalancer:Backend
        name: test_backend
        properties:
          backendSetName: ${testBackendSet.name}
          networkLoadBalancerId: ${testNetworkLoadBalancer.id}
          port: ${backendPort}
          ipAddress: ${backendIpAddress}
          isBackup: ${backendIsBackup}
          isDrain: ${backendIsDrain}
          isOffline: ${backendIsOffline}
          name: ${backendName}
          targetId: ${testTarget.id}
          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,
                backend_set_name: Optional[str] = None,
                network_load_balancer_id: Optional[str] = None,
                port: Optional[int] = None,
                ip_address: Optional[str] = None,
                is_backup: Optional[bool] = None,
                is_drain: Optional[bool] = None,
                is_offline: Optional[bool] = None,
                name: Optional[str] = None,
                target_id: Optional[str] = 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:NetworkLoadBalancer: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 ociBackendResource = new Oci.NetworkLoadBalancer.Backend("ociBackendResource", new()
    {
        BackendSetName = "string",
        NetworkLoadBalancerId = "string",
        Port = 0,
        IpAddress = "string",
        IsBackup = false,
        IsDrain = false,
        IsOffline = false,
        Name = "string",
        TargetId = "string",
        Weight = 0,
    });
    
    example, err := NetworkLoadBalancer.NewBackend(ctx, "ociBackendResource", &NetworkLoadBalancer.BackendArgs{
    	BackendSetName:        pulumi.String("string"),
    	NetworkLoadBalancerId: pulumi.String("string"),
    	Port:                  pulumi.Int(0),
    	IpAddress:             pulumi.String("string"),
    	IsBackup:              pulumi.Bool(false),
    	IsDrain:               pulumi.Bool(false),
    	IsOffline:             pulumi.Bool(false),
    	Name:                  pulumi.String("string"),
    	TargetId:              pulumi.String("string"),
    	Weight:                pulumi.Int(0),
    })
    
    var ociBackendResource = new Backend("ociBackendResource", BackendArgs.builder()
        .backendSetName("string")
        .networkLoadBalancerId("string")
        .port(0)
        .ipAddress("string")
        .isBackup(false)
        .isDrain(false)
        .isOffline(false)
        .name("string")
        .targetId("string")
        .weight(0)
        .build());
    
    oci_backend_resource = oci.network_load_balancer.Backend("ociBackendResource",
        backend_set_name="string",
        network_load_balancer_id="string",
        port=0,
        ip_address="string",
        is_backup=False,
        is_drain=False,
        is_offline=False,
        name="string",
        target_id="string",
        weight=0)
    
    const ociBackendResource = new oci.networkloadbalancer.Backend("ociBackendResource", {
        backendSetName: "string",
        networkLoadBalancerId: "string",
        port: 0,
        ipAddress: "string",
        isBackup: false,
        isDrain: false,
        isOffline: false,
        name: "string",
        targetId: "string",
        weight: 0,
    });
    
    type: oci:NetworkLoadBalancer:Backend
    properties:
        backendSetName: string
        ipAddress: string
        isBackup: false
        isDrain: false
        isOffline: false
        name: string
        networkLoadBalancerId: string
        port: 0
        targetId: string
        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 which to add the backend server. Example: example_backend_set
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    The communication port for the backend server. Example: 8080
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IsBackup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    IsDrain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    IsOffline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    TargetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    Weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    The communication port for the backend server. Example: 8080
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IsBackup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    IsDrain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    IsOffline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    TargetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    Weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Integer
    The communication port for the backend server. Example: 8080
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    isBackup Boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain Boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline Boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name String
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    targetId String
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight Integer

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    networkLoadBalancerId string
    The OCID of the network load balancer to update.
    port number
    The communication port for the backend server. Example: 8080
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    isBackup boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    targetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight number

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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

    backend_set_name str
    The name of the backend set to which to add the backend server. Example: example_backend_set
    network_load_balancer_id str
    The OCID of the network load balancer to update.
    port int
    The communication port for the backend server. Example: 8080
    ip_address str
    The IP address of the backend server. Example: 10.0.0.3
    is_backup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    is_drain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    is_offline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name str
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    target_id str
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Number
    The communication port for the backend server. Example: 8080
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    isBackup Boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain Boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline Boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name String
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    targetId String
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight Number

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
            backend_set_name: Optional[str] = None,
            ip_address: Optional[str] = None,
            is_backup: Optional[bool] = None,
            is_drain: Optional[bool] = None,
            is_offline: Optional[bool] = None,
            name: Optional[str] = None,
            network_load_balancer_id: Optional[str] = None,
            port: Optional[int] = None,
            target_id: 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 which to add the backend server. Example: example_backend_set
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IsBackup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    IsDrain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    IsOffline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    The communication port for the backend server. Example: 8080
    TargetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    Weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    IsBackup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    IsDrain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    IsOffline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    Name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    NetworkLoadBalancerId string
    The OCID of the network load balancer to update.
    Port int
    The communication port for the backend server. Example: 8080
    TargetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    Weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    isBackup Boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain Boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline Boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name String
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Integer
    The communication port for the backend server. Example: 8080
    targetId String
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight Integer

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    isBackup boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name string
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    networkLoadBalancerId string
    The OCID of the network load balancer to update.
    port number
    The communication port for the backend server. Example: 8080
    targetId string
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight number

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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

    backend_set_name str
    The name of the backend set to which to add the backend server. Example: example_backend_set
    ip_address str
    The IP address of the backend server. Example: 10.0.0.3
    is_backup bool
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    is_drain bool
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    is_offline bool
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name str
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    network_load_balancer_id str
    The OCID of the network load balancer to update.
    port int
    The communication port for the backend server. Example: 8080
    target_id str
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight int

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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 which to add the backend server. Example: example_backend_set
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    isBackup Boolean
    (Updatable) Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false
    isDrain Boolean
    (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false
    isOffline Boolean
    (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
    name String
    Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: webServer1
    networkLoadBalancerId String
    The OCID of the network load balancer to update.
    port Number
    The communication port for the backend server. Example: 8080
    targetId String
    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>
    weight Number

    (Updatable) The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network 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:NetworkLoadBalancer/backend:Backend test_backend "networkLoadBalancers/{networkLoadBalancerId}/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.40.0 published on Wednesday, Jun 12, 2024 by Pulumi