Docs
Packagesoci.NetworkLoadBalancer.Backend
Explore with Pulumi AI
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("testBackend", {
backendSetName: oci_network_load_balancer_backend_set.test_backend_set.name,
networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
port: _var.backend_port,
ipAddress: _var.backend_ip_address,
isBackup: _var.backend_is_backup,
isDrain: _var.backend_is_drain,
isOffline: _var.backend_is_offline,
targetId: oci_cloud_guard_target.test_target.id,
weight: _var.backend_weight,
});
import pulumi
import pulumi_oci as oci
test_backend = oci.network_load_balancer.Backend("testBackend",
backend_set_name=oci_network_load_balancer_backend_set["test_backend_set"]["name"],
network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"],
port=var["backend_port"],
ip_address=var["backend_ip_address"],
is_backup=var["backend_is_backup"],
is_drain=var["backend_is_drain"],
is_offline=var["backend_is_offline"],
target_id=oci_cloud_guard_target["test_target"]["id"],
weight=var["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, "testBackend", &NetworkLoadBalancer.BackendArgs{
BackendSetName: pulumi.Any(oci_network_load_balancer_backend_set.Test_backend_set.Name),
NetworkLoadBalancerId: pulumi.Any(oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id),
Port: pulumi.Any(_var.Backend_port),
IpAddress: pulumi.Any(_var.Backend_ip_address),
IsBackup: pulumi.Any(_var.Backend_is_backup),
IsDrain: pulumi.Any(_var.Backend_is_drain),
IsOffline: pulumi.Any(_var.Backend_is_offline),
TargetId: pulumi.Any(oci_cloud_guard_target.Test_target.Id),
Weight: pulumi.Any(_var.Backend_weight),
})
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("testBackend", new()
{
BackendSetName = oci_network_load_balancer_backend_set.Test_backend_set.Name,
NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
Port = @var.Backend_port,
IpAddress = @var.Backend_ip_address,
IsBackup = @var.Backend_is_backup,
IsDrain = @var.Backend_is_drain,
IsOffline = @var.Backend_is_offline,
TargetId = oci_cloud_guard_target.Test_target.Id,
Weight = @var.Backend_weight,
});
});
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(oci_network_load_balancer_backend_set.test_backend_set().name())
.networkLoadBalancerId(oci_network_load_balancer_network_load_balancer.test_network_load_balancer().id())
.port(var_.backend_port())
.ipAddress(var_.backend_ip_address())
.isBackup(var_.backend_is_backup())
.isDrain(var_.backend_is_drain())
.isOffline(var_.backend_is_offline())
.targetId(oci_cloud_guard_target.test_target().id())
.weight(var_.backend_weight())
.build());
}
}
resources:
testBackend:
type: oci:NetworkLoadBalancer:Backend
properties:
#Required
backendSetName: ${oci_network_load_balancer_backend_set.test_backend_set.name}
networkLoadBalancerId: ${oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id}
port: ${var.backend_port}
#Optional
ipAddress: ${var.backend_ip_address}
isBackup: ${var.backend_is_backup}
isDrain: ${var.backend_is_drain}
isOffline: ${var.backend_is_offline}
targetId: ${oci_cloud_guard_target.test_target.id}
weight: ${var.backend_weight}
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:
- Backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Port int
- The communication port for the backend server. Example:
8080 - Ip
Address string - 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 string
- Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example:
webServer1 - Target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- Backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Port int
- The communication port for the backend server. Example:
8080 - Ip
Address string - 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 string
- Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example:
webServer1 - Target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- backend
Set StringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - network
Load StringBalancer Id - The OCID of the network load balancer to update.
- port Integer
- The communication port for the backend server. Example:
8080 - ip
Address String - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain Boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - target
Id String - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - network
Load stringBalancer Id - The OCID of the network load balancer to update.
- port number
- The communication port for the backend server. Example:
8080 - ip
Address string - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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_ strname - The name of the backend set to which to add the backend server. Example:
example_backend_set - network_
load_ strbalancer_ id - 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><unique_ID></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
- backend
Set StringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - network
Load StringBalancer Id - The OCID of the network load balancer to update.
- port Number
- The communication port for the backend server. Example:
8080 - ip
Address String - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain Boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - target
Id String - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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) -> Backendfunc 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.
- Backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - Ip
Address string - 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 string
- Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example:
webServer1 - Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Port int
- The communication port for the backend server. Example:
8080 - Target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- Backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - Ip
Address string - 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 string
- Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example:
webServer1 - Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Port int
- The communication port for the backend server. Example:
8080 - Target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- backend
Set StringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - ip
Address String - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain Boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - network
Load StringBalancer Id - The OCID of the network load balancer to update.
- port Integer
- The communication port for the backend server. Example:
8080 - target
Id String - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- backend
Set stringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - ip
Address string - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - network
Load stringBalancer Id - The OCID of the network load balancer to update.
- port number
- The communication port for the backend server. Example:
8080 - target
Id string - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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_ strname - 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_ strbalancer_ id - 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><unique_ID></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
- backend
Set StringName - The name of the backend set to which to add the backend server. Example:
example_backend_set - ip
Address String - The IP address of the backend server. Example:
10.0.0.3 - is
Backup 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 - is
Drain Boolean - (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false - is
Offline 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 - network
Load StringBalancer Id - The OCID of the network load balancer to update.
- port Number
- The communication port for the backend server. Example:
8080 - target
Id String - The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
ociTerraform Provider.