Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. BackendSet
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-oci

oci.NetworkLoadBalancer.BackendSet

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-oci

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

    Adds a backend set to a network load balancer.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testBackendSet = new Oci.NetworkLoadBalancer.BackendSet("testBackendSet", new()
    {
        HealthChecker = new Oci.NetworkLoadBalancer.Inputs.BackendSetHealthCheckerArgs
        {
            Protocol = @var.Backend_set_health_checker_protocol,
            IntervalInMillis = @var.Backend_set_health_checker_interval_in_millis,
            Port = @var.Backend_set_health_checker_port,
            RequestData = @var.Backend_set_health_checker_request_data,
            ResponseBodyRegex = @var.Backend_set_health_checker_response_body_regex,
            ResponseData = @var.Backend_set_health_checker_response_data,
            Retries = @var.Backend_set_health_checker_retries,
            ReturnCode = @var.Backend_set_health_checker_return_code,
            TimeoutInMillis = @var.Backend_set_health_checker_timeout_in_millis,
            UrlPath = @var.Backend_set_health_checker_url_path,
        },
        NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
        Policy = @var.Backend_set_policy,
        IpVersion = @var.Backend_set_ip_version,
        IsPreserveSource = @var.Backend_set_is_preserve_source,
    });

});

    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.NewBackendSet(ctx, "testBackendSet", &NetworkLoadBalancer.BackendSetArgs{
			HealthChecker: &networkloadbalancer.BackendSetHealthCheckerArgs{
				Protocol:          pulumi.Any(_var.Backend_set_health_checker_protocol),
				IntervalInMillis:  pulumi.Any(_var.Backend_set_health_checker_interval_in_millis),
				Port:              pulumi.Any(_var.Backend_set_health_checker_port),
				RequestData:       pulumi.Any(_var.Backend_set_health_checker_request_data),
				ResponseBodyRegex: pulumi.Any(_var.Backend_set_health_checker_response_body_regex),
				ResponseData:      pulumi.Any(_var.Backend_set_health_checker_response_data),
				Retries:           pulumi.Any(_var.Backend_set_health_checker_retries),
				ReturnCode:        pulumi.Any(_var.Backend_set_health_checker_return_code),
				TimeoutInMillis:   pulumi.Any(_var.Backend_set_health_checker_timeout_in_millis),
				UrlPath:           pulumi.Any(_var.Backend_set_health_checker_url_path),
			},
			NetworkLoadBalancerId: pulumi.Any(oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id),
			Policy:                pulumi.Any(_var.Backend_set_policy),
			IpVersion:             pulumi.Any(_var.Backend_set_ip_version),
			IsPreserveSource:      pulumi.Any(_var.Backend_set_is_preserve_source),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.NetworkLoadBalancer.BackendSet;
import com.pulumi.oci.NetworkLoadBalancer.BackendSetArgs;
import com.pulumi.oci.NetworkLoadBalancer.inputs.BackendSetHealthCheckerArgs;
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 testBackendSet = new BackendSet("testBackendSet", BackendSetArgs.builder()        
            .healthChecker(BackendSetHealthCheckerArgs.builder()
                .protocol(var_.backend_set_health_checker_protocol())
                .intervalInMillis(var_.backend_set_health_checker_interval_in_millis())
                .port(var_.backend_set_health_checker_port())
                .requestData(var_.backend_set_health_checker_request_data())
                .responseBodyRegex(var_.backend_set_health_checker_response_body_regex())
                .responseData(var_.backend_set_health_checker_response_data())
                .retries(var_.backend_set_health_checker_retries())
                .returnCode(var_.backend_set_health_checker_return_code())
                .timeoutInMillis(var_.backend_set_health_checker_timeout_in_millis())
                .urlPath(var_.backend_set_health_checker_url_path())
                .build())
            .networkLoadBalancerId(oci_network_load_balancer_network_load_balancer.test_network_load_balancer().id())
            .policy(var_.backend_set_policy())
            .ipVersion(var_.backend_set_ip_version())
            .isPreserveSource(var_.backend_set_is_preserve_source())
            .build());

    }
}

    import pulumi
import pulumi_oci as oci

test_backend_set = oci.network_load_balancer.BackendSet("testBackendSet",
    health_checker=oci.network_load_balancer.BackendSetHealthCheckerArgs(
        protocol=var["backend_set_health_checker_protocol"],
        interval_in_millis=var["backend_set_health_checker_interval_in_millis"],
        port=var["backend_set_health_checker_port"],
        request_data=var["backend_set_health_checker_request_data"],
        response_body_regex=var["backend_set_health_checker_response_body_regex"],
        response_data=var["backend_set_health_checker_response_data"],
        retries=var["backend_set_health_checker_retries"],
        return_code=var["backend_set_health_checker_return_code"],
        timeout_in_millis=var["backend_set_health_checker_timeout_in_millis"],
        url_path=var["backend_set_health_checker_url_path"],
    ),
    network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"],
    policy=var["backend_set_policy"],
    ip_version=var["backend_set_ip_version"],
    is_preserve_source=var["backend_set_is_preserve_source"])

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testBackendSet = new oci.networkloadbalancer.BackendSet("testBackendSet", {
    healthChecker: {
        protocol: _var.backend_set_health_checker_protocol,
        intervalInMillis: _var.backend_set_health_checker_interval_in_millis,
        port: _var.backend_set_health_checker_port,
        requestData: _var.backend_set_health_checker_request_data,
        responseBodyRegex: _var.backend_set_health_checker_response_body_regex,
        responseData: _var.backend_set_health_checker_response_data,
        retries: _var.backend_set_health_checker_retries,
        returnCode: _var.backend_set_health_checker_return_code,
        timeoutInMillis: _var.backend_set_health_checker_timeout_in_millis,
        urlPath: _var.backend_set_health_checker_url_path,
    },
    networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
    policy: _var.backend_set_policy,
    ipVersion: _var.backend_set_ip_version,
    isPreserveSource: _var.backend_set_is_preserve_source,
});

    resources:
  testBackendSet:
    type: oci:NetworkLoadBalancer:BackendSet
    properties:
      healthChecker:
        protocol: ${var.backend_set_health_checker_protocol}
        intervalInMillis: ${var.backend_set_health_checker_interval_in_millis}
        port: ${var.backend_set_health_checker_port}
        requestData: ${var.backend_set_health_checker_request_data}
        responseBodyRegex: ${var.backend_set_health_checker_response_body_regex}
        responseData: ${var.backend_set_health_checker_response_data}
        retries: ${var.backend_set_health_checker_retries}
        returnCode: ${var.backend_set_health_checker_return_code}
        timeoutInMillis: ${var.backend_set_health_checker_timeout_in_millis}
        urlPath: ${var.backend_set_health_checker_url_path}
      networkLoadBalancerId: ${oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id}
      policy: ${var.backend_set_policy}
      #Optional
      ipVersion: ${var.backend_set_ip_version}
      isPreserveSource: ${var.backend_set_is_preserve_source}

    Create BackendSet Resource

    new BackendSet(name: string, args: BackendSetArgs, opts?: CustomResourceOptions);
    @overload
def BackendSet(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               health_checker: Optional[_networkloadbalancer.BackendSetHealthCheckerArgs] = None,
               ip_version: Optional[str] = None,
               is_preserve_source: Optional[bool] = None,
               name: Optional[str] = None,
               network_load_balancer_id: Optional[str] = None,
               policy: Optional[str] = None)
@overload
def BackendSet(resource_name: str,
               args: BackendSetArgs,
               opts: Optional[ResourceOptions] = None)
    func NewBackendSet(ctx *Context, name string, args BackendSetArgs, opts ...ResourceOption) (*BackendSet, error)
    public BackendSet(string name, BackendSetArgs args, CustomResourceOptions? opts = null)
    public BackendSet(String name, BackendSetArgs args)
public BackendSet(String name, BackendSetArgs args, CustomResourceOptions options)

    type: oci:NetworkLoadBalancer:BackendSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendSetArgs
    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 BackendSetArgs
    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 BackendSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    HealthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    Policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    IpVersion string

    (Updatable) IP version associated with the backend set.

    IsPreserveSource bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    HealthChecker BackendSetHealthCheckerArgs

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    Policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    IpVersion string

    (Updatable) IP version associated with the backend set.

    IsPreserveSource bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    healthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    policy String

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    ipVersion String

    (Updatable) IP version associated with the backend set.

    isPreserveSource Boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    healthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    networkLoadBalancerId string

    The OCID of the network load balancer to update.

    policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    ipVersion string

    (Updatable) IP version associated with the backend set.

    isPreserveSource boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    health_checker BackendSetHealthCheckerArgs

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    network_load_balancer_id str

    The OCID of the network load balancer to update.

    policy str

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    ip_version str

    (Updatable) IP version associated with the backend set.

    is_preserve_source bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name str

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    healthChecker Property Map

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    policy String

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    ipVersion String

    (Updatable) IP version associated with the backend set.

    isPreserveSource Boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    Outputs

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

    Backends List<BackendSetBackend>

    Array of backends.

    Id string

    The provider-assigned unique ID for this managed resource.

    Backends []BackendSetBackend

    Array of backends.

    Id string

    The provider-assigned unique ID for this managed resource.

    backends List<BackendSetBackend>

    Array of backends.

    id String

    The provider-assigned unique ID for this managed resource.

    backends BackendSetBackend[]

    Array of backends.

    id string

    The provider-assigned unique ID for this managed resource.

    backends BackendSetBackend]

    Array of backends.

    id str

    The provider-assigned unique ID for this managed resource.

    backends List<Property Map>

    Array of backends.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing BackendSet Resource

    Get an existing BackendSet 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?: BackendSetState, opts?: CustomResourceOptions): BackendSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backends: Optional[Sequence[_networkloadbalancer.BackendSetBackendArgs]] = None,
        health_checker: Optional[_networkloadbalancer.BackendSetHealthCheckerArgs] = None,
        ip_version: Optional[str] = None,
        is_preserve_source: Optional[bool] = None,
        name: Optional[str] = None,
        network_load_balancer_id: Optional[str] = None,
        policy: Optional[str] = None) -> BackendSet
    func GetBackendSet(ctx *Context, name string, id IDInput, state *BackendSetState, opts ...ResourceOption) (*BackendSet, error)
    public static BackendSet Get(string name, Input<string> id, BackendSetState? state, CustomResourceOptions? opts = null)
    public static BackendSet get(String name, Output<String> id, BackendSetState 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:
    Backends List<BackendSetBackend>

    Array of backends.

    HealthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    IpVersion string

    (Updatable) IP version associated with the backend set.

    IsPreserveSource bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    Policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    Backends []BackendSetBackendArgs

    Array of backends.

    HealthChecker BackendSetHealthCheckerArgs

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    IpVersion string

    (Updatable) IP version associated with the backend set.

    IsPreserveSource bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    Policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    backends List<BackendSetBackend>

    Array of backends.

    healthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    ipVersion String

    (Updatable) IP version associated with the backend set.

    isPreserveSource Boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    policy String

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    backends BackendSetBackend[]

    Array of backends.

    healthChecker BackendSetHealthChecker

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    ipVersion string

    (Updatable) IP version associated with the backend set.

    isPreserveSource boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    networkLoadBalancerId string

    The OCID of the network load balancer to update.

    policy string

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    backends BackendSetBackendArgs]

    Array of backends.

    health_checker BackendSetHealthCheckerArgs

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    ip_version str

    (Updatable) IP version associated with the backend set.

    is_preserve_source bool

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name str

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    network_load_balancer_id str

    The OCID of the network load balancer to update.

    policy str

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    backends List<Property Map>

    Array of backends.

    healthChecker Property Map

    (Updatable) The health check policy configuration. For more information, see Editing Health Check Policies.

    ipVersion String

    (Updatable) IP version associated with the backend set.

    isPreserveSource Boolean

    (Updatable) If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    policy String

    (Updatable) The network load balancer policy for the backend set. Example: `FIVE_TUPLE``

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

    Supporting Types

    BackendSetBackend, BackendSetBackendArgs

    Port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    IpAddress string

    The IP address of the backend server. Example: 10.0.0.3

    IsBackup bool

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    IsOffline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    TargetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    Weight int

    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

    Port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    IpAddress string

    The IP address of the backend server. Example: 10.0.0.3

    IsBackup bool

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    IsOffline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    TargetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    Weight int

    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

    port Integer

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    ipAddress String

    The IP address of the backend server. Example: 10.0.0.3

    isBackup Boolean

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline Boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    targetId String

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight Integer

    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

    port number

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    ipAddress string

    The IP address of the backend server. Example: 10.0.0.3

    isBackup boolean

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    targetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight number

    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

    port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    ip_address str

    The IP address of the backend server. Example: 10.0.0.3

    is_backup bool

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    is_offline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name str

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    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

    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

    port Number

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    ipAddress String

    The IP address of the backend server. Example: 10.0.0.3

    isBackup Boolean

    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

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline Boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

    Example: example_backend_set

    targetId String

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight Number

    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

    BackendSetHealthChecker, BackendSetHealthCheckerArgs

    Protocol string

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    IntervalInMillis int

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    Port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    RequestData string

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    ResponseBodyRegex string

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    ResponseData string

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    Retries int

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    ReturnCode int

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    TimeoutInMillis int

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    UrlPath string

    (Updatable) The path against which to run the health check. Example: /healthcheck

    Protocol string

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    IntervalInMillis int

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    Port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    RequestData string

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    ResponseBodyRegex string

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    ResponseData string

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    Retries int

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    ReturnCode int

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    TimeoutInMillis int

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    UrlPath string

    (Updatable) The path against which to run the health check. Example: /healthcheck

    protocol String

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    intervalInMillis Integer

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port Integer

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    requestData String

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex String

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData String

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries Integer

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode Integer

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    timeoutInMillis Integer

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    urlPath String

    (Updatable) The path against which to run the health check. Example: /healthcheck

    protocol string

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    intervalInMillis number

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port number

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    requestData string

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex string

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData string

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries number

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode number

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    timeoutInMillis number

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    urlPath string

    (Updatable) The path against which to run the health check. Example: /healthcheck

    protocol str

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    interval_in_millis int

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port int

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    request_data str

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    response_body_regex str

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    response_data str

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries int

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    return_code int

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    timeout_in_millis int

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    url_path str

    (Updatable) The path against which to run the health check. Example: /healthcheck

    protocol String

    (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    intervalInMillis Number

    (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port Number

    (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    requestData String

    (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex String

    (Updatable) A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData String

    (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries Number

    (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode Number

    (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    timeoutInMillis Number

    (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: 3000

    urlPath String

    (Updatable) The path against which to run the health check. Example: /healthcheck

    Import

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

     $ pulumi import oci:NetworkLoadBalancer/backendSet:BackendSet test_backend_set "networkLoadBalancers/{networkLoadBalancerId}/backendSets/{backendSetName}"

    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.11.0 published on Wednesday, Sep 27, 2023 by Pulumi
    pulumi/pulumi-oci