Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. BackendSet
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.NetworkLoadBalancer.BackendSet

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 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

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

const testBackendSet = new oci.networkloadbalancer.BackendSet("test_backend_set", {
    healthChecker: {
        protocol: backendSetHealthCheckerProtocol,
        dns: {
            domainName: testDomain.name,
            queryClass: backendSetHealthCheckerDnsQueryClass,
            queryType: backendSetHealthCheckerDnsQueryType,
            rcodes: backendSetHealthCheckerDnsRcodes,
            transportProtocol: backendSetHealthCheckerDnsTransportProtocol,
        },
        intervalInMillis: backendSetHealthCheckerIntervalInMillis,
        port: backendSetHealthCheckerPort,
        requestData: backendSetHealthCheckerRequestData,
        responseBodyRegex: backendSetHealthCheckerResponseBodyRegex,
        responseData: backendSetHealthCheckerResponseData,
        retries: backendSetHealthCheckerRetries,
        returnCode: backendSetHealthCheckerReturnCode,
        timeoutInMillis: backendSetHealthCheckerTimeoutInMillis,
        urlPath: backendSetHealthCheckerUrlPath,
    },
    name: backendSetName,
    networkLoadBalancerId: testNetworkLoadBalancer.id,
    policy: backendSetPolicy,
    ipVersion: backendSetIpVersion,
    isFailOpen: backendSetIsFailOpen,
    isInstantFailoverEnabled: backendSetIsInstantFailoverEnabled,
    isPreserveSource: backendSetIsPreserveSource,
});

    import pulumi
import pulumi_oci as oci

test_backend_set = oci.network_load_balancer.BackendSet("test_backend_set",
    health_checker={
        "protocol": backend_set_health_checker_protocol,
        "dns": {
            "domain_name": test_domain["name"],
            "query_class": backend_set_health_checker_dns_query_class,
            "query_type": backend_set_health_checker_dns_query_type,
            "rcodes": backend_set_health_checker_dns_rcodes,
            "transport_protocol": backend_set_health_checker_dns_transport_protocol,
        },
        "interval_in_millis": backend_set_health_checker_interval_in_millis,
        "port": backend_set_health_checker_port,
        "request_data": backend_set_health_checker_request_data,
        "response_body_regex": backend_set_health_checker_response_body_regex,
        "response_data": backend_set_health_checker_response_data,
        "retries": backend_set_health_checker_retries,
        "return_code": backend_set_health_checker_return_code,
        "timeout_in_millis": backend_set_health_checker_timeout_in_millis,
        "url_path": backend_set_health_checker_url_path,
    },
    name=backend_set_name,
    network_load_balancer_id=test_network_load_balancer["id"],
    policy=backend_set_policy,
    ip_version=backend_set_ip_version,
    is_fail_open=backend_set_is_fail_open,
    is_instant_failover_enabled=backend_set_is_instant_failover_enabled,
    is_preserve_source=backend_set_is_preserve_source)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/NetworkLoadBalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := NetworkLoadBalancer.NewBackendSet(ctx, "test_backend_set", &NetworkLoadBalancer.BackendSetArgs{
			HealthChecker: &networkloadbalancer.BackendSetHealthCheckerArgs{
				Protocol: pulumi.Any(backendSetHealthCheckerProtocol),
				Dns: &networkloadbalancer.BackendSetHealthCheckerDnsArgs{
					DomainName:        pulumi.Any(testDomain.Name),
					QueryClass:        pulumi.Any(backendSetHealthCheckerDnsQueryClass),
					QueryType:         pulumi.Any(backendSetHealthCheckerDnsQueryType),
					Rcodes:            pulumi.Any(backendSetHealthCheckerDnsRcodes),
					TransportProtocol: pulumi.Any(backendSetHealthCheckerDnsTransportProtocol),
				},
				IntervalInMillis:  pulumi.Any(backendSetHealthCheckerIntervalInMillis),
				Port:              pulumi.Any(backendSetHealthCheckerPort),
				RequestData:       pulumi.Any(backendSetHealthCheckerRequestData),
				ResponseBodyRegex: pulumi.Any(backendSetHealthCheckerResponseBodyRegex),
				ResponseData:      pulumi.Any(backendSetHealthCheckerResponseData),
				Retries:           pulumi.Any(backendSetHealthCheckerRetries),
				ReturnCode:        pulumi.Any(backendSetHealthCheckerReturnCode),
				TimeoutInMillis:   pulumi.Any(backendSetHealthCheckerTimeoutInMillis),
				UrlPath:           pulumi.Any(backendSetHealthCheckerUrlPath),
			},
			Name:                     pulumi.Any(backendSetName),
			NetworkLoadBalancerId:    pulumi.Any(testNetworkLoadBalancer.Id),
			Policy:                   pulumi.Any(backendSetPolicy),
			IpVersion:                pulumi.Any(backendSetIpVersion),
			IsFailOpen:               pulumi.Any(backendSetIsFailOpen),
			IsInstantFailoverEnabled: pulumi.Any(backendSetIsInstantFailoverEnabled),
			IsPreserveSource:         pulumi.Any(backendSetIsPreserveSource),
		})
		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 testBackendSet = new Oci.NetworkLoadBalancer.BackendSet("test_backend_set", new()
    {
        HealthChecker = new Oci.NetworkLoadBalancer.Inputs.BackendSetHealthCheckerArgs
        {
            Protocol = backendSetHealthCheckerProtocol,
            Dns = new Oci.NetworkLoadBalancer.Inputs.BackendSetHealthCheckerDnsArgs
            {
                DomainName = testDomain.Name,
                QueryClass = backendSetHealthCheckerDnsQueryClass,
                QueryType = backendSetHealthCheckerDnsQueryType,
                Rcodes = backendSetHealthCheckerDnsRcodes,
                TransportProtocol = backendSetHealthCheckerDnsTransportProtocol,
            },
            IntervalInMillis = backendSetHealthCheckerIntervalInMillis,
            Port = backendSetHealthCheckerPort,
            RequestData = backendSetHealthCheckerRequestData,
            ResponseBodyRegex = backendSetHealthCheckerResponseBodyRegex,
            ResponseData = backendSetHealthCheckerResponseData,
            Retries = backendSetHealthCheckerRetries,
            ReturnCode = backendSetHealthCheckerReturnCode,
            TimeoutInMillis = backendSetHealthCheckerTimeoutInMillis,
            UrlPath = backendSetHealthCheckerUrlPath,
        },
        Name = backendSetName,
        NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
        Policy = backendSetPolicy,
        IpVersion = backendSetIpVersion,
        IsFailOpen = backendSetIsFailOpen,
        IsInstantFailoverEnabled = backendSetIsInstantFailoverEnabled,
        IsPreserveSource = backendSetIsPreserveSource,
    });

});

    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 com.pulumi.oci.NetworkLoadBalancer.inputs.BackendSetHealthCheckerDnsArgs;
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(backendSetHealthCheckerProtocol)
                .dns(BackendSetHealthCheckerDnsArgs.builder()
                    .domainName(testDomain.name())
                    .queryClass(backendSetHealthCheckerDnsQueryClass)
                    .queryType(backendSetHealthCheckerDnsQueryType)
                    .rcodes(backendSetHealthCheckerDnsRcodes)
                    .transportProtocol(backendSetHealthCheckerDnsTransportProtocol)
                    .build())
                .intervalInMillis(backendSetHealthCheckerIntervalInMillis)
                .port(backendSetHealthCheckerPort)
                .requestData(backendSetHealthCheckerRequestData)
                .responseBodyRegex(backendSetHealthCheckerResponseBodyRegex)
                .responseData(backendSetHealthCheckerResponseData)
                .retries(backendSetHealthCheckerRetries)
                .returnCode(backendSetHealthCheckerReturnCode)
                .timeoutInMillis(backendSetHealthCheckerTimeoutInMillis)
                .urlPath(backendSetHealthCheckerUrlPath)
                .build())
            .name(backendSetName)
            .networkLoadBalancerId(testNetworkLoadBalancer.id())
            .policy(backendSetPolicy)
            .ipVersion(backendSetIpVersion)
            .isFailOpen(backendSetIsFailOpen)
            .isInstantFailoverEnabled(backendSetIsInstantFailoverEnabled)
            .isPreserveSource(backendSetIsPreserveSource)
            .build());

    }
}

    resources:
  testBackendSet:
    type: oci:NetworkLoadBalancer:BackendSet
    name: test_backend_set
    properties:
      healthChecker:
        protocol: ${backendSetHealthCheckerProtocol}
        dns:
          domainName: ${testDomain.name}
          queryClass: ${backendSetHealthCheckerDnsQueryClass}
          queryType: ${backendSetHealthCheckerDnsQueryType}
          rcodes: ${backendSetHealthCheckerDnsRcodes}
          transportProtocol: ${backendSetHealthCheckerDnsTransportProtocol}
        intervalInMillis: ${backendSetHealthCheckerIntervalInMillis}
        port: ${backendSetHealthCheckerPort}
        requestData: ${backendSetHealthCheckerRequestData}
        responseBodyRegex: ${backendSetHealthCheckerResponseBodyRegex}
        responseData: ${backendSetHealthCheckerResponseData}
        retries: ${backendSetHealthCheckerRetries}
        returnCode: ${backendSetHealthCheckerReturnCode}
        timeoutInMillis: ${backendSetHealthCheckerTimeoutInMillis}
        urlPath: ${backendSetHealthCheckerUrlPath}
      name: ${backendSetName}
      networkLoadBalancerId: ${testNetworkLoadBalancer.id}
      policy: ${backendSetPolicy}
      ipVersion: ${backendSetIpVersion}
      isFailOpen: ${backendSetIsFailOpen}
      isInstantFailoverEnabled: ${backendSetIsInstantFailoverEnabled}
      isPreserveSource: ${backendSetIsPreserveSource}

    Create BackendSet Resource

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

    Constructor syntax

    new BackendSet(name: string, args: BackendSetArgs, opts?: CustomResourceOptions);
    @overload
def BackendSet(resource_name: str,
               args: BackendSetArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def BackendSet(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               health_checker: Optional[_networkloadbalancer.BackendSetHealthCheckerArgs] = None,
               network_load_balancer_id: Optional[str] = None,
               policy: Optional[str] = None,
               ip_version: Optional[str] = None,
               is_fail_open: Optional[bool] = None,
               is_instant_failover_enabled: Optional[bool] = None,
               is_preserve_source: Optional[bool] = None,
               name: Optional[str] = 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.

    Parameters

    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.

    Constructor example

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

    var ociBackendSetResource = new Oci.NetworkLoadBalancer.BackendSet("ociBackendSetResource", new()
{
    HealthChecker = new Oci.NetworkLoadBalancer.Inputs.BackendSetHealthCheckerArgs
    {
        Protocol = "string",
        Dns = new Oci.NetworkLoadBalancer.Inputs.BackendSetHealthCheckerDnsArgs
        {
            DomainName = "string",
            QueryClass = "string",
            QueryType = "string",
            Rcodes = new[]
            {
                "string",
            },
            TransportProtocol = "string",
        },
        IntervalInMillis = 0,
        Port = 0,
        RequestData = "string",
        ResponseBodyRegex = "string",
        ResponseData = "string",
        Retries = 0,
        ReturnCode = 0,
        TimeoutInMillis = 0,
        UrlPath = "string",
    },
    NetworkLoadBalancerId = "string",
    Policy = "string",
    IpVersion = "string",
    IsFailOpen = false,
    IsInstantFailoverEnabled = false,
    IsPreserveSource = false,
    Name = "string",
});

    example, err := NetworkLoadBalancer.NewBackendSet(ctx, "ociBackendSetResource", &NetworkLoadBalancer.BackendSetArgs{
	HealthChecker: &networkloadbalancer.BackendSetHealthCheckerArgs{
		Protocol: pulumi.String("string"),
		Dns: &networkloadbalancer.BackendSetHealthCheckerDnsArgs{
			DomainName: pulumi.String("string"),
			QueryClass: pulumi.String("string"),
			QueryType:  pulumi.String("string"),
			Rcodes: pulumi.StringArray{
				pulumi.String("string"),
			},
			TransportProtocol: pulumi.String("string"),
		},
		IntervalInMillis:  pulumi.Int(0),
		Port:              pulumi.Int(0),
		RequestData:       pulumi.String("string"),
		ResponseBodyRegex: pulumi.String("string"),
		ResponseData:      pulumi.String("string"),
		Retries:           pulumi.Int(0),
		ReturnCode:        pulumi.Int(0),
		TimeoutInMillis:   pulumi.Int(0),
		UrlPath:           pulumi.String("string"),
	},
	NetworkLoadBalancerId:    pulumi.String("string"),
	Policy:                   pulumi.String("string"),
	IpVersion:                pulumi.String("string"),
	IsFailOpen:               pulumi.Bool(false),
	IsInstantFailoverEnabled: pulumi.Bool(false),
	IsPreserveSource:         pulumi.Bool(false),
	Name:                     pulumi.String("string"),
})

    var ociBackendSetResource = new BackendSet("ociBackendSetResource", BackendSetArgs.builder()
    .healthChecker(BackendSetHealthCheckerArgs.builder()
        .protocol("string")
        .dns(BackendSetHealthCheckerDnsArgs.builder()
            .domainName("string")
            .queryClass("string")
            .queryType("string")
            .rcodes("string")
            .transportProtocol("string")
            .build())
        .intervalInMillis(0)
        .port(0)
        .requestData("string")
        .responseBodyRegex("string")
        .responseData("string")
        .retries(0)
        .returnCode(0)
        .timeoutInMillis(0)
        .urlPath("string")
        .build())
    .networkLoadBalancerId("string")
    .policy("string")
    .ipVersion("string")
    .isFailOpen(false)
    .isInstantFailoverEnabled(false)
    .isPreserveSource(false)
    .name("string")
    .build());

    oci_backend_set_resource = oci.network_load_balancer.BackendSet("ociBackendSetResource",
    health_checker={
        "protocol": "string",
        "dns": {
            "domain_name": "string",
            "query_class": "string",
            "query_type": "string",
            "rcodes": ["string"],
            "transport_protocol": "string",
        },
        "interval_in_millis": 0,
        "port": 0,
        "request_data": "string",
        "response_body_regex": "string",
        "response_data": "string",
        "retries": 0,
        "return_code": 0,
        "timeout_in_millis": 0,
        "url_path": "string",
    },
    network_load_balancer_id="string",
    policy="string",
    ip_version="string",
    is_fail_open=False,
    is_instant_failover_enabled=False,
    is_preserve_source=False,
    name="string")

    const ociBackendSetResource = new oci.networkloadbalancer.BackendSet("ociBackendSetResource", {
    healthChecker: {
        protocol: "string",
        dns: {
            domainName: "string",
            queryClass: "string",
            queryType: "string",
            rcodes: ["string"],
            transportProtocol: "string",
        },
        intervalInMillis: 0,
        port: 0,
        requestData: "string",
        responseBodyRegex: "string",
        responseData: "string",
        retries: 0,
        returnCode: 0,
        timeoutInMillis: 0,
        urlPath: "string",
    },
    networkLoadBalancerId: "string",
    policy: "string",
    ipVersion: "string",
    isFailOpen: false,
    isInstantFailoverEnabled: false,
    isPreserveSource: false,
    name: "string",
});

    type: oci:NetworkLoadBalancer:BackendSet
properties:
    healthChecker:
        dns:
            domainName: string
            queryClass: string
            queryType: string
            rcodes:
                - string
            transportProtocol: string
        intervalInMillis: 0
        port: 0
        protocol: string
        requestData: string
        responseBodyRegex: string
        responseData: string
        retries: 0
        returnCode: 0
        timeoutInMillis: 0
        urlPath: string
    ipVersion: string
    isFailOpen: false
    isInstantFailoverEnabled: false
    isPreserveSource: false
    name: string
    networkLoadBalancerId: string
    policy: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    IsFailOpen bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    IsInstantFailoverEnabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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.
    IsFailOpen bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    IsInstantFailoverEnabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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.
    isFailOpen Boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled Boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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.
    isFailOpen boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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 networkloadbalancer.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_fail_open bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    is_instant_failover_enabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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.
    isFailOpen Boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled Boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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>
    (Updatable) An array of backends to be associated with the backend set.
    Id string
    The provider-assigned unique ID for this managed resource.
    Backends []BackendSetBackend
    (Updatable) An array of backends to be associated with the backend set.
    Id string
    The provider-assigned unique ID for this managed resource.
    backends List<BackendSetBackend>
    (Updatable) An array of backends to be associated with the backend set.
    id String
    The provider-assigned unique ID for this managed resource.
    backends BackendSetBackend[]
    (Updatable) An array of backends to be associated with the backend set.
    id string
    The provider-assigned unique ID for this managed resource.
    backends Sequence[networkloadbalancer.BackendSetBackend]
    (Updatable) An array of backends to be associated with the backend set.
    id str
    The provider-assigned unique ID for this managed resource.
    backends List<Property Map>
    (Updatable) An array of backends to be associated with the backend set.
    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_fail_open: Optional[bool] = None,
        is_instant_failover_enabled: Optional[bool] = 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>
    (Updatable) An array of backends to be associated with the backend set.
    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.
    IsFailOpen bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    IsInstantFailoverEnabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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
    (Updatable) An array of backends to be associated with the backend set.
    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.
    IsFailOpen bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    IsInstantFailoverEnabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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>
    (Updatable) An array of backends to be associated with the backend set.
    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.
    isFailOpen Boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled Boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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[]
    (Updatable) An array of backends to be associated with the backend set.
    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.
    isFailOpen boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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 Sequence[networkloadbalancer.BackendSetBackendArgs]
    (Updatable) An array of backends to be associated with the backend set.
    health_checker networkloadbalancer.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_fail_open bool
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    is_instant_failover_enabled bool
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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>
    (Updatable) An array of backends to be associated with the backend set.
    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.
    isFailOpen Boolean
    (Updatable) If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default.
    isInstantFailoverEnabled Boolean
    (Updatable) If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
    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 communication port for the backend server. Example: 8080
    IpAddress string
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    TargetId string
    (Updatable) 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
    Port int
    (Updatable) The communication port for the backend server. Example: 8080
    IpAddress string
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    TargetId string
    (Updatable) 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
    port Integer
    (Updatable) The communication port for the backend server. Example: 8080
    ipAddress String
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    targetId String
    (Updatable) 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
    port number
    (Updatable) The communication port for the backend server. Example: 8080
    ipAddress string
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    targetId string
    (Updatable) 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
    port int
    (Updatable) The communication port for the backend server. Example: 8080
    ip_address str
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    target_id str
    (Updatable) 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
    port Number
    (Updatable) The communication port for the backend server. Example: 8080
    ipAddress String
    (Updatable) 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
    (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443 or 10.0.0.3:0
    targetId String
    (Updatable) 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

    BackendSetHealthChecker, BackendSetHealthCheckerArgs

    Protocol string
    (Updatable) The protocol the health check must use; either HTTP, HTTPS, UDP, TCP or DNS. Example: HTTP
    Dns BackendSetHealthCheckerDns
    (Updatable) DNS healthcheck configurations.
    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, HTTPS, UDP, TCP or DNS. Example: HTTP
    Dns BackendSetHealthCheckerDns
    (Updatable) DNS healthcheck configurations.
    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, HTTPS, UDP, TCP or DNS. Example: HTTP
    dns BackendSetHealthCheckerDns
    (Updatable) DNS healthcheck configurations.
    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, HTTPS, UDP, TCP or DNS. Example: HTTP
    dns BackendSetHealthCheckerDns
    (Updatable) DNS healthcheck configurations.
    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, HTTPS, UDP, TCP or DNS. Example: HTTP
    dns networkloadbalancer.BackendSetHealthCheckerDns
    (Updatable) DNS healthcheck configurations.
    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, HTTPS, UDP, TCP or DNS. Example: HTTP
    dns Property Map
    (Updatable) DNS healthcheck configurations.
    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

    BackendSetHealthCheckerDns, BackendSetHealthCheckerDnsArgs

    DomainName string
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    QueryClass string
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    QueryType string
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    Rcodes List<string>
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    TransportProtocol string
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP
    DomainName string
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    QueryClass string
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    QueryType string
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    Rcodes []string
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    TransportProtocol string
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP
    domainName String
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    queryClass String
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    queryType String
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    rcodes List<String>
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    transportProtocol String
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP
    domainName string
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    queryClass string
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    queryType string
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    rcodes string[]
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    transportProtocol string
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP
    domain_name str
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    query_class str
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    query_type str
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    rcodes Sequence[str]
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    transport_protocol str
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP
    domainName String
    (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query.
    queryClass String
    (Updatable) The class the dns health check query to use; either IN or CH. Example: IN
    queryType String
    (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: A
    rcodes List<String>
    (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
    transportProtocol String
    (Updatable) DNS transport protocol; either UDP or TCP. Example: UDP

    Import

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

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

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci