Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.LoadBalancer.getBackendSets
Explore with Pulumi AI
This data source provides the list of Backend Sets in Oracle Cloud Infrastructure Load Balancer service.
Lists all backend sets associated with a given load balancer.
Supported Aliases
- oci_load_balancer_backendsets
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBackendSets = oci.LoadBalancer.getBackendSets({
    loadBalancerId: testLoadBalancer.id,
});
import pulumi
import pulumi_oci as oci
test_backend_sets = oci.LoadBalancer.get_backend_sets(load_balancer_id=test_load_balancer["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.GetBackendSets(ctx, &loadbalancer.GetBackendSetsArgs{
			LoadBalancerId: testLoadBalancer.Id,
		}, nil)
		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 testBackendSets = Oci.LoadBalancer.GetBackendSets.Invoke(new()
    {
        LoadBalancerId = testLoadBalancer.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LoadBalancer.LoadBalancerFunctions;
import com.pulumi.oci.LoadBalancer.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 = LoadBalancerFunctions.getBackendSets(GetBackendSetsArgs.builder()
            .loadBalancerId(testLoadBalancer.id())
            .build());
    }
}
variables:
  testBackendSets:
    fn::invoke:
      function: oci:LoadBalancer:getBackendSets
      arguments:
        loadBalancerId: ${testLoadBalancer.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[GetBackendSetsFilter]] = None,
                     load_balancer_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBackendSetsResult
def get_backend_sets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBackendSetsFilterArgs]]]] = None,
                     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)
public static Output<GetBackendSetsResult> getBackendSets(GetBackendSetsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:LoadBalancer/getBackendSets:getBackendSets
  arguments:
    # arguments dictionaryThe following arguments are supported:
- LoadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- Filters
List<GetBackend Sets Filter> 
- LoadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- Filters
[]GetBackend Sets Filter 
- loadBalancer StringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- filters
List<GetBackend Sets Filter> 
- loadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- filters
GetBackend Sets Filter[] 
- load_balancer_ strid 
- The OCID of the load balancer associated with the backend sets to retrieve.
- filters
Sequence[GetBackend Sets Filter] 
- loadBalancer StringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- filters List<Property Map>
getBackendSets Result
The following output properties are available:
- Backendsets
List<GetBackend Sets Backendset> 
- The list of backendsets.
- Id string
- The provider-assigned unique ID for this managed resource.
- LoadBalancer stringId 
- Filters
List<GetBackend Sets Filter> 
- Backendsets
[]GetBackend Sets Backendset 
- The list of backendsets.
- Id string
- The provider-assigned unique ID for this managed resource.
- LoadBalancer stringId 
- Filters
[]GetBackend Sets Filter 
- backendsets
List<GetBackend Sets Backendset> 
- The list of backendsets.
- id String
- The provider-assigned unique ID for this managed resource.
- loadBalancer StringId 
- filters
List<GetBackend Sets Filter> 
- backendsets
GetBackend Sets Backendset[] 
- The list of backendsets.
- id string
- The provider-assigned unique ID for this managed resource.
- loadBalancer stringId 
- filters
GetBackend Sets Filter[] 
- backendsets
Sequence[GetBackend Sets Backendset] 
- The list of backendsets.
- id str
- The provider-assigned unique ID for this managed resource.
- load_balancer_ strid 
- filters
Sequence[GetBackend Sets Filter] 
- backendsets List<Property Map>
- The list of backendsets.
- id String
- The provider-assigned unique ID for this managed resource.
- loadBalancer StringId 
- filters List<Property Map>
Supporting Types
GetBackendSetsBackendset   
- BackendMax intConnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- Backends
List<GetBackend Sets Backendset Backend> 
- HealthCheckers List<GetBackend Sets Backendset Health Checker> 
- The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- 
List<GetBackend Sets Backendset Lb Cookie Session Persistence Configuration> 
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- LoadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- Name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- Policy string
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- SessionPersistence List<GetConfigurations Backend Sets Backendset Session Persistence Configuration> 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- SslConfigurations List<GetBackend Sets Backendset Ssl Configuration> 
- A listener's SSL handling configuration.
- State string
- BackendMax intConnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- Backends
[]GetBackend Sets Backendset Backend 
- HealthCheckers []GetBackend Sets Backendset Health Checker 
- The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- 
[]GetBackend Sets Backendset Lb Cookie Session Persistence Configuration 
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- LoadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- Name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- Policy string
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- SessionPersistence []GetConfigurations Backend Sets Backendset Session Persistence Configuration 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- SslConfigurations []GetBackend Sets Backendset Ssl Configuration 
- A listener's SSL handling configuration.
- State string
- backendMax IntegerConnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- backends
List<GetBackend Sets Backendset Backend> 
- healthCheckers List<GetBackend Sets Backendset Health Checker> 
- The health check policy configuration. For more information, see Editing Health Check Policies.
- id String
- 
List<GetBackend Sets Backendset Lb Cookie Session Persistence Configuration> 
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- loadBalancer StringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- name String
- A friendly name for the backend set. It must be unique and it cannot be changed.
- policy String
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- sessionPersistence List<GetConfigurations Backend Sets Backendset Session Persistence Configuration> 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- sslConfigurations List<GetBackend Sets Backendset Ssl Configuration> 
- A listener's SSL handling configuration.
- state String
- backendMax numberConnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- backends
GetBackend Sets Backendset Backend[] 
- healthCheckers GetBackend Sets Backendset Health Checker[] 
- The health check policy configuration. For more information, see Editing Health Check Policies.
- id string
- 
GetBackend Sets Backendset Lb Cookie Session Persistence Configuration[] 
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- loadBalancer stringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- policy string
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- sessionPersistence GetConfigurations Backend Sets Backendset Session Persistence Configuration[] 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- sslConfigurations GetBackend Sets Backendset Ssl Configuration[] 
- A listener's SSL handling configuration.
- state string
- backend_max_ intconnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- backends
Sequence[GetBackend Sets Backendset Backend] 
- health_checkers Sequence[GetBackend Sets Backendset Health Checker] 
- The health check policy configuration. For more information, see Editing Health Check Policies.
- id str
- 
Sequence[GetBackend Sets Backendset Lb Cookie Session Persistence Configuration] 
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load_balancer_ strid 
- The OCID of the load balancer associated with the backend sets to retrieve.
- name str
- A friendly name for the backend set. It must be unique and it cannot be changed.
- policy str
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- session_persistence_ Sequence[Getconfigurations Backend Sets Backendset Session Persistence Configuration] 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl_configurations Sequence[GetBackend Sets Backendset Ssl Configuration] 
- A listener's SSL handling configuration.
- state str
- backendMax NumberConnections 
- The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300
- backends List<Property Map>
- healthCheckers List<Property Map>
- The health check policy configuration. For more information, see Editing Health Check Policies.
- id String
- List<Property Map>
- The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- loadBalancer StringId 
- The OCID of the load balancer associated with the backend sets to retrieve.
- name String
- A friendly name for the backend set. It must be unique and it cannot be changed.
- policy String
- The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS
- sessionPersistence List<Property Map>Configurations 
- The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- sslConfigurations List<Property Map>
- A listener's SSL handling configuration.
- state String
GetBackendSetsBackendsetBackend    
- Backup bool
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- Drain bool
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- IpAddress string
- The IP address of the backend server. Example: 10.0.0.3
- MaxConnections int
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- Name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- Offline bool
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- Port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- Weight int
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
- Backup bool
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- Drain bool
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- IpAddress string
- The IP address of the backend server. Example: 10.0.0.3
- MaxConnections int
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- Name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- Offline bool
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- Port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- Weight int
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
- backup Boolean
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- drain Boolean
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- ipAddress String
- The IP address of the backend server. Example: 10.0.0.3
- maxConnections Integer
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- name String
- A friendly name for the backend set. It must be unique and it cannot be changed.
- offline Boolean
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- port Integer
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- weight Integer
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
- backup boolean
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- drain boolean
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- ipAddress string
- The IP address of the backend server. Example: 10.0.0.3
- maxConnections number
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- name string
- A friendly name for the backend set. It must be unique and it cannot be changed.
- offline boolean
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- port number
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- weight number
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
- backup bool
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- drain bool
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- ip_address str
- The IP address of the backend server. Example: 10.0.0.3
- max_connections int
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- name str
- A friendly name for the backend set. It must be unique and it cannot be changed.
- offline bool
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- weight int
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
- backup Boolean
- Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
- drain Boolean
- Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false
- ipAddress String
- The IP address of the backend server. Example: 10.0.0.3
- maxConnections Number
- The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300
- name String
- A friendly name for the backend set. It must be unique and it cannot be changed.
- offline Boolean
- Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false
- port Number
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- weight Number
- The 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 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3
GetBackendSetsBackendsetHealthChecker     
- IntervalMs int
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- IsForce boolPlain Text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- Port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- Protocol string
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- ResponseBody stringRegex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 3. Example: 3
- ReturnCode int
- The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200
- TimeoutIn 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. Defaults to 3000 (3 seconds). Example: 3000
- UrlPath string
- The path against which to run the health check. Example: /healthcheck
- IntervalMs int
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- IsForce boolPlain Text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- Port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- Protocol string
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- ResponseBody stringRegex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 3. Example: 3
- ReturnCode int
- The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200
- TimeoutIn 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. Defaults to 3000 (3 seconds). Example: 3000
- UrlPath string
- The path against which to run the health check. Example: /healthcheck
- intervalMs Integer
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- isForce BooleanPlain Text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- port Integer
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- protocol String
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- responseBody StringRegex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 3. Example: 3
- returnCode Integer
- The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200
- timeoutIn 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. Defaults to 3000 (3 seconds). Example: 3000
- urlPath String
- The path against which to run the health check. Example: /healthcheck
- intervalMs number
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- isForce booleanPlain Text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- port number
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- protocol string
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- responseBody stringRegex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 3. Example: 3
- returnCode number
- The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200
- timeoutIn 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. Defaults to 3000 (3 seconds). Example: 3000
- urlPath string
- The path against which to run the health check. Example: /healthcheck
- interval_ms int
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- is_force_ boolplain_ text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- port int
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- protocol str
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- response_body_ strregex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 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, 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. Defaults to 3000 (3 seconds). Example: 3000
- url_path str
- The path against which to run the health check. Example: /healthcheck
- intervalMs Number
- The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
- isForce BooleanPlain Text 
- Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
- port Number
- The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backendobject. Example:8080
- protocol String
- The protocol the health check must use; either HTTP or TCP. Example: HTTP
- responseBody StringRegex 
- A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$
- 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. Defaults to 3. Example: 3
- returnCode Number
- The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: 200
- timeoutIn 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. Defaults to 3000 (3 seconds). Example: 3000
- urlPath String
- The path against which to run the health check. Example: /healthcheck
GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration        
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- DisableFallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- Domain string
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- IsHttp boolOnly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- IsSecure bool
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- MaxAge intIn Seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- Path string
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- DisableFallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- Domain string
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- IsHttp boolOnly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- IsSecure bool
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- MaxAge intIn Seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- Path string
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
- String
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback Boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- domain String
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- isHttp BooleanOnly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- isSecure Boolean
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- maxAge IntegerIn Seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- path String
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- domain string
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- isHttp booleanOnly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- isSecure boolean
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- maxAge numberIn Seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- path string
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
- str
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disable_fallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- domain str
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- is_http_ boolonly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- is_secure bool
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- max_age_ intin_ seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- path str
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
- String
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback Boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- domain String
- The domain in which the cookie is valid. The Set-cookieheader inserted by the load balancer contains a domain attribute with the specified value.
- isHttp BooleanOnly 
- Whether the Set-cookieheader should contain theHttpOnlyattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theHttpOnlyattribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- isSecure Boolean
- Whether the Set-cookieheader should contain theSecureattribute. Iftrue, theSet-cookieheader inserted by the load balancer contains theSecureattribute, which directs the client or browser to send the cookie only using a secure protocol.
- maxAge NumberIn Seconds 
- The amount of time the cookie remains valid. The Set-cookieheader inserted by the load balancer contains aMax-Ageattribute with the specified value.
- path String
- The path in which the cookie is valid. The Set-cookie headerinserted by the load balancer contains aPathattribute with the specified value.
GetBackendSetsBackendsetSessionPersistenceConfiguration      
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- DisableFallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- DisableFallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- String
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback Boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- string
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- str
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disable_fallback bool
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
- String
- The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: example_cookie
- disableFallback Boolean
- Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: false
GetBackendSetsBackendsetSslConfiguration     
- CertificateIds List<string>
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- CertificateName string
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- CipherSuite stringName 
- The name of the cipher suite to use for HTTPS or SSL connections.
- Protocols List<string>
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- ServerOrder stringPreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<string>
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- VerifyDepth int
- The maximum depth for peer certificate chain verification. Example: 3
- VerifyPeer boolCertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
- CertificateIds []string
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- CertificateName string
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- CipherSuite stringName 
- The name of the cipher suite to use for HTTPS or SSL connections.
- Protocols []string
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- ServerOrder stringPreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- []string
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- VerifyDepth int
- The maximum depth for peer certificate chain verification. Example: 3
- VerifyPeer boolCertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
- certificateIds List<String>
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificateName String
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- cipherSuite StringName 
- The name of the cipher suite to use for HTTPS or SSL connections.
- protocols List<String>
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- serverOrder StringPreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<String>
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verifyDepth Integer
- The maximum depth for peer certificate chain verification. Example: 3
- verifyPeer BooleanCertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
- certificateIds string[]
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificateName string
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- cipherSuite stringName 
- The name of the cipher suite to use for HTTPS or SSL connections.
- protocols string[]
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- serverOrder stringPreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- string[]
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verifyDepth number
- The maximum depth for peer certificate chain verification. Example: 3
- verifyPeer booleanCertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
- certificate_ids Sequence[str]
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificate_name str
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- cipher_suite_ strname 
- The name of the cipher suite to use for HTTPS or SSL connections.
- protocols Sequence[str]
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- server_order_ strpreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- Sequence[str]
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verify_depth int
- The maximum depth for peer certificate chain verification. Example: 3
- verify_peer_ boolcertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
- certificateIds List<String>
- Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificateName String
- A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle
- cipherSuite StringName 
- The name of the cipher suite to use for HTTPS or SSL connections.
- protocols List<String>
- A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- serverOrder StringPreference 
- When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<String>
- Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verifyDepth Number
- The maximum depth for peer certificate chain verification. Example: 3
- verifyPeer BooleanCertificate 
- Whether the load balancer listener should verify peer certificates. Example: true
GetBackendSetsFilter   
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.