Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Backend

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

Adds a backend server to a backend set.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testBackend = new Oci.NetworkLoadBalancer.Backend("testBackend", new Oci.NetworkLoadBalancer.BackendArgs
        {
            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 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
	})
}

Coming soon!

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"])
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,
});

Coming soon!

Create a Backend Resource

new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
@overload
def Backend(resource_name: 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)
@overload
def Backend(resource_name: str,
            args: BackendArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

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

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

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

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

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

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 an 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

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

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

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

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

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

Import

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

 $ pulumi import oci:NetworkLoadBalancer/backend:Backend test_backend "networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}/backends/{backendName}"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.