oci.NetworkLoadBalancer.getBackendSets
Explore with Pulumi AI
This data source provides the list of Backend Sets in Oracle Cloud Infrastructure Network Load Balancer service.
Lists all backend sets associated with a given network load balancer.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testBackendSets = Oci.NetworkLoadBalancer.GetBackendSets.Invoke(new()
{
NetworkLoadBalancerId = oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
});
});
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.GetBackendSets(ctx, &networkloadbalancer.GetBackendSetsArgs{
NetworkLoadBalancerId: oci_network_load_balancer_network_load_balancer.Test_network_load_balancer.Id,
}, nil)
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.NetworkLoadBalancerFunctions;
import com.pulumi.oci.NetworkLoadBalancer.inputs.GetBackendSetsArgs;
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) {
final var testBackendSets = NetworkLoadBalancerFunctions.getBackendSets(GetBackendSetsArgs.builder()
.networkLoadBalancerId(oci_network_load_balancer_network_load_balancer.test_network_load_balancer().id())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_backend_sets = oci.NetworkLoadBalancer.get_backend_sets(network_load_balancer_id=oci_network_load_balancer_network_load_balancer["test_network_load_balancer"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBackendSets = oci.NetworkLoadBalancer.getBackendSets({
networkLoadBalancerId: oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id,
});
variables:
testBackendSets:
fn::invoke:
Function: oci:NetworkLoadBalancer:getBackendSets
Arguments:
networkLoadBalancerId: ${oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id}
Using getBackendSets
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBackendSets(args: GetBackendSetsArgs, opts?: InvokeOptions): Promise<GetBackendSetsResult>
function getBackendSetsOutput(args: GetBackendSetsOutputArgs, opts?: InvokeOptions): Output<GetBackendSetsResult>
def get_backend_sets(filters: Optional[Sequence[_networkloadbalancer.GetBackendSetsFilter]] = None,
network_load_balancer_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackendSetsResult
def get_backend_sets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_networkloadbalancer.GetBackendSetsFilterArgs]]]] = None,
network_load_balancer_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackendSetsResult]
func GetBackendSets(ctx *Context, args *GetBackendSetsArgs, opts ...InvokeOption) (*GetBackendSetsResult, error)
func GetBackendSetsOutput(ctx *Context, args *GetBackendSetsOutputArgs, opts ...InvokeOption) GetBackendSetsResultOutput
> Note: This function is named GetBackendSets
in the Go SDK.
public static class GetBackendSets
{
public static Task<GetBackendSetsResult> InvokeAsync(GetBackendSetsArgs args, InvokeOptions? opts = null)
public static Output<GetBackendSetsResult> Invoke(GetBackendSetsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackendSetsResult> getBackendSets(GetBackendSetsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:NetworkLoadBalancer/getBackendSets:getBackendSets
arguments:
# arguments dictionary
The following arguments are supported:
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- Filters
List<Get
Backend Sets Filter>
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- Filters
[]Get
Backend Sets Filter
- network
Load StringBalancer Id The OCID of the network load balancer to update.
- filters
List<Get
Backend Sets Filter>
- network
Load stringBalancer Id The OCID of the network load balancer to update.
- filters
Get
Backend Sets Filter[]
- network_
load_ strbalancer_ id The OCID of the network load balancer to update.
- filters
Get
Backend Sets Filter]
- network
Load StringBalancer Id The OCID of the network load balancer to update.
- filters List<Property Map>
getBackendSets Result
The following output properties are available:
- Backend
Set List<GetCollections Backend Sets Backend Set Collection> The list of backend_set_collection.
- Id string
The provider-assigned unique ID for this managed resource.
- Network
Load stringBalancer Id - Filters
List<Get
Backend Sets Filter>
- Backend
Set []GetCollections Backend Sets Backend Set Collection The list of backend_set_collection.
- Id string
The provider-assigned unique ID for this managed resource.
- Network
Load stringBalancer Id - Filters
[]Get
Backend Sets Filter
- backend
Set List<GetCollections Backend Sets Backend Set Collection> The list of backend_set_collection.
- id String
The provider-assigned unique ID for this managed resource.
- network
Load StringBalancer Id - filters
List<Get
Backend Sets Filter>
- backend
Set GetCollections Backend Sets Backend Set Collection[] The list of backend_set_collection.
- id string
The provider-assigned unique ID for this managed resource.
- network
Load stringBalancer Id - filters
Get
Backend Sets Filter[]
- backend_
set_ Getcollections Backend Sets Backend Set Collection] The list of backend_set_collection.
- id str
The provider-assigned unique ID for this managed resource.
- network_
load_ strbalancer_ id - filters
Get
Backend Sets Filter]
- backend
Set List<Property Map>Collections The list of backend_set_collection.
- id String
The provider-assigned unique ID for this managed resource.
- network
Load StringBalancer Id - filters List<Property Map>
Supporting Types
GetBackendSetsBackendSetCollection
GetBackendSetsBackendSetCollectionItem
- Backends
List<Get
Backend Sets Backend Set Collection Item Backend> Array of backends.
- Health
Checkers List<GetBackend Sets Backend Set Collection Item Health Checker> The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- Ip
Version string IP version associated with the backend set.
- Is
Preserve boolSource 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.
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- Policy string
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- Backends
[]Get
Backend Sets Backend Set Collection Item Backend Array of backends.
- Health
Checkers []GetBackend Sets Backend Set Collection Item Health Checker The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- Ip
Version string IP version associated with the backend set.
- Is
Preserve boolSource 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.
- Network
Load stringBalancer Id The OCID of the network load balancer to update.
- Policy string
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backends
List<Get
Backend Sets Backend Set Collection Item Backend> Array of backends.
- health
Checkers List<GetBackend Sets Backend Set Collection Item Health Checker> The health check policy configuration. For more information, see Editing Health Check Policies.
- id String
- ip
Version String IP version associated with the backend set.
- is
Preserve BooleanSource 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.
- network
Load StringBalancer Id The OCID of the network load balancer to update.
- policy String
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backends
Get
Backend Sets Backend Set Collection Item Backend[] Array of backends.
- health
Checkers GetBackend Sets Backend Set Collection Item Health Checker[] The health check policy configuration. For more information, see Editing Health Check Policies.
- id string
- ip
Version string IP version associated with the backend set.
- is
Preserve booleanSource 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.
- network
Load stringBalancer Id The OCID of the network load balancer to update.
- policy string
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backends
Get
Backend Sets Backend Set Collection Item Backend] Array of backends.
- health_
checkers GetBackend Sets Backend Set Collection Item Health Checker] The health check policy configuration. For more information, see Editing Health Check Policies.
- id str
- ip_
version str IP version associated with the backend set.
- is_
preserve_ boolsource 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.
- network_
load_ strbalancer_ id The OCID of the network load balancer to update.
- policy str
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backends List<Property Map>
Array of backends.
- health
Checkers List<Property Map> The health check policy configuration. For more information, see Editing Health Check Policies.
- id String
- ip
Version String IP version associated with the backend set.
- is
Preserve BooleanSource 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.
- network
Load StringBalancer Id The OCID of the network load balancer to update.
- policy String
The network load balancer policy for the backend set. Example:
FIVE_TUPLE
GetBackendSetsBackendSetCollectionItemBackend
- Ip
Address string 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 string
A user-friendly name for the backend set that must be unique and cannot be changed.
- Port int
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
- Target
Id string The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- Ip
Address string 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 string
A user-friendly name for the backend set that must be unique and cannot be changed.
- Port int
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
- Target
Id string The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- ip
Address String The IP address of the backend server. Example:
10.0.0.3
- is
Backup 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
- is
Drain Boolean Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false
- is
Offline 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.
- port Integer
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
- target
Id String The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- ip
Address string The IP address of the backend server. Example:
10.0.0.3
- is
Backup 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
- is
Drain boolean Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false
- is
Offline 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.
- port number
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
- target
Id string The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- 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.
- port int
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
- target_
id str The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
- ip
Address String The IP address of the backend server. Example:
10.0.0.3
- is
Backup 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
- is
Drain Boolean Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example:
false
- is
Offline 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.
- port Number
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
- target
Id String The IP OCID/Instance OCID associated with the backend server. Example:
ocid1.privateip..oc1.<var><unique_ID></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
GetBackendSetsBackendSetCollectionItemHealthChecker
- Interval
In intMillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- Port int
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
- Protocol string
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- Request
Data string Base64 encoded pattern to be sent as UDP or TCP health check probe.
- Response
Body stringRegex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- Response
Data string Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- Retries int
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 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 intMillis 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 string The path against which to run the health check. Example:
/healthcheck
- Interval
In intMillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- Port int
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
- Protocol string
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- Request
Data string Base64 encoded pattern to be sent as UDP or TCP health check probe.
- Response
Body stringRegex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- Response
Data string Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- Retries int
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 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 intMillis 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 string The path against which to run the health check. Example:
/healthcheck
- interval
In IntegerMillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- port Integer
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
- protocol String
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- request
Data String Base64 encoded pattern to be sent as UDP or TCP health check probe.
- response
Body StringRegex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- response
Data String Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- retries Integer
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 Integer 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 IntegerMillis 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 String The path against which to run the health check. Example:
/healthcheck
- interval
In numberMillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- port number
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
- protocol string
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- request
Data string Base64 encoded pattern to be sent as UDP or TCP health check probe.
- response
Body stringRegex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- response
Data string Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- retries number
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 number 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 numberMillis 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 string The path against which to run the health check. Example:
/healthcheck
- interval_
in_ intmillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- port int
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
- protocol str
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- request_
data str Base64 encoded pattern to be sent as UDP or TCP health check probe.
- response_
body_ strregex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- response_
data str Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- retries int
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 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_ intmillis 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 The path against which to run the health check. Example:
/healthcheck
- interval
In NumberMillis The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example:
10000
- port Number
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
- protocol String
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example:
HTTP
- request
Data String Base64 encoded pattern to be sent as UDP or TCP health check probe.
- response
Body StringRegex A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- response
Data String Base64 encoded pattern to be validated as UDP or TCP health check probe response.
- retries Number
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 Number 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 NumberMillis 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 String The path against which to run the health check. Example:
/healthcheck
GetBackendSetsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.