Oracle Cloud Infrastructure v2.12.0 published on Friday, Oct 11, 2024 by Pulumi
oci.NetworkLoadBalancer.getBackendSet
Explore with Pulumi AI
This data source provides details about a specific Backend Set resource in Oracle Cloud Infrastructure Network Load Balancer service.
Retrieves the configuration information for the specified backend set.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.GetBackendSetArgs;
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 testBackendSet = NetworkLoadBalancerFunctions.getBackendSet(GetBackendSetArgs.builder()
.backendSetName(testBackendSetOciNetworkLoadBalancerBackendSet.name())
.networkLoadBalancerId(testNetworkLoadBalancer.id())
.ipVersion(backendSetIpVersion)
.build());
}
}
variables:
testBackendSet:
fn::invoke:
Function: oci:NetworkLoadBalancer:getBackendSet
Arguments:
backendSetName: ${testBackendSetOciNetworkLoadBalancerBackendSet.name}
networkLoadBalancerId: ${testNetworkLoadBalancer.id}
ipVersion: ${backendSetIpVersion}
Using getBackendSet
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 getBackendSet(args: GetBackendSetArgs, opts?: InvokeOptions): Promise<GetBackendSetResult>
function getBackendSetOutput(args: GetBackendSetOutputArgs, opts?: InvokeOptions): Output<GetBackendSetResult>
def get_backend_set(backend_set_name: Optional[str] = None,
network_load_balancer_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackendSetResult
def get_backend_set_output(backend_set_name: Optional[pulumi.Input[str]] = None,
network_load_balancer_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackendSetResult]
func GetBackendSet(ctx *Context, args *GetBackendSetArgs, opts ...InvokeOption) (*GetBackendSetResult, error)
func GetBackendSetOutput(ctx *Context, args *GetBackendSetOutputArgs, opts ...InvokeOption) GetBackendSetResultOutput
> Note: This function is named GetBackendSet
in the Go SDK.
public static class GetBackendSet
{
public static Task<GetBackendSetResult> InvokeAsync(GetBackendSetArgs args, InvokeOptions? opts = null)
public static Output<GetBackendSetResult> Invoke(GetBackendSetInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackendSetResult> getBackendSet(GetBackendSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:NetworkLoadBalancer/getBackendSet:getBackendSet
arguments:
# arguments dictionary
The following arguments are supported:
- Backend
Set stringName - The name of the backend set to retrieve. Example:
example_backend_set
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Backend
Set stringName - The name of the backend set to retrieve. Example:
example_backend_set
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- backend
Set StringName - The name of the backend set to retrieve. Example:
example_backend_set
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
- backend
Set stringName - The name of the backend set to retrieve. Example:
example_backend_set
- network
Load stringBalancer Id - The OCID of the network load balancer to update.
- backend_
set_ strname - The name of the backend set to retrieve. Example:
example_backend_set
- network_
load_ strbalancer_ id - The OCID of the network load balancer to update.
- backend
Set StringName - The name of the backend set to retrieve. Example:
example_backend_set
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
getBackendSet Result
The following output properties are available:
- Backend
Set stringName - Backends
List<Get
Backend Set Backend> - Array of backends.
- Health
Checkers List<GetBackend Set 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
Fail boolOpen - 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 boolFailover Enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - Policy string
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- Backend
Set stringName - Backends
[]Get
Backend Set Backend - Array of backends.
- Health
Checkers []GetBackend Set 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
Fail boolOpen - 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 boolFailover Enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - Policy string
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backend
Set StringName - backends
List<Get
Backend Set Backend> - Array of backends.
- health
Checkers List<GetBackend Set 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
Fail BooleanOpen - 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 BooleanFailover Enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - policy String
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backend
Set stringName - backends
Get
Backend Set Backend[] - Array of backends.
- health
Checkers GetBackend Set 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
Fail booleanOpen - 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 booleanFailover Enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - policy string
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backend_
set_ strname - backends
Sequence[networkloadbalancer.
Get Backend Set Backend] - Array of backends.
- health_
checkers Sequence[networkloadbalancer.Get Backend Set 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_
fail_ boolopen - 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_ boolfailover_ enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - policy str
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
- backend
Set StringName - 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
Fail BooleanOpen - 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 BooleanFailover Enabled - If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
- 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 - policy String
- The network load balancer policy for the backend set. Example:
FIVE_TUPLE
Supporting Types
GetBackendSetBackend
- 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
GetBackendSetHealthChecker
- Dns
List<Get
Backend Set Health Checker Dn> - DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
- Dns
[]Get
Backend Set Health Checker Dn - DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
- dns
List<Get
Backend Set Health Checker Dn> - DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
- dns
Get
Backend Set Health Checker Dn[] - DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
- dns
Sequence[networkloadbalancer.
Get Backend Set Health Checker Dn] - DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
- dns List<Property Map>
- DNS healthcheck configurations.
- 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, HTTPS, UDP, TCP or DNS. 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
GetBackendSetHealthCheckerDn
- Domain
Name string - 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 string - The class the dns health check query to use; either IN or CH. Example:
IN
- Query
Type string - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- Rcodes List<string>
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- Transport
Protocol string - DNS transport protocol; either UDP or TCP. Example:
UDP
- Domain
Name string - 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 string - The class the dns health check query to use; either IN or CH. Example:
IN
- Query
Type string - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- Rcodes []string
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- Transport
Protocol string - DNS transport protocol; either UDP or TCP. Example:
UDP
- domain
Name String - 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 String - The class the dns health check query to use; either IN or CH. Example:
IN
- query
Type String - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- rcodes List<String>
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- transport
Protocol String - DNS transport protocol; either UDP or TCP. Example:
UDP
- domain
Name string - 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 string - The class the dns health check query to use; either IN or CH. Example:
IN
- query
Type string - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- rcodes string[]
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- transport
Protocol string - DNS transport protocol; either UDP or TCP. Example:
UDP
- domain_
name str - 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 - The class the dns health check query to use; either IN or CH. Example:
IN
- query_
type str - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- rcodes Sequence[str]
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- transport_
protocol str - DNS transport protocol; either UDP or TCP. Example:
UDP
- domain
Name String - 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 String - The class the dns health check query to use; either IN or CH. Example:
IN
- query
Type String - The type the dns health check query to use; A, AAAA, TXT. Example:
A
- rcodes List<String>
- An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"]
- transport
Protocol String - DNS transport protocol; either UDP or TCP. Example:
UDP
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.