Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 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[_loadbalancer.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[_loadbalancer.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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:LoadBalancer/getBackendSets:getBackendSets
arguments:
# arguments dictionary
The following arguments are supported:
- Load
Balancer stringId - The OCID of the load balancer associated with the backend sets to retrieve.
- Filters
List<Get
Backend Sets Filter>
- Load
Balancer stringId - The OCID of the load balancer associated with the backend sets to retrieve.
- Filters
[]Get
Backend Sets Filter
- load
Balancer StringId - The OCID of the load balancer associated with the backend sets to retrieve.
- filters
List<Get
Backend Sets Filter>
- load
Balancer stringId - The OCID of the load balancer associated with the backend sets to retrieve.
- filters
Get
Backend Sets Filter[]
- load_
balancer_ strid - The OCID of the load balancer associated with the backend sets to retrieve.
- filters
Sequence[loadbalancer.
Get Backend Sets Filter]
- load
Balancer 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<Get
Backend Sets Backendset> - The list of backendsets.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer stringId - Filters
List<Get
Backend Sets Filter>
- Backendsets
[]Get
Backend Sets Backendset - The list of backendsets.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer stringId - Filters
[]Get
Backend Sets Filter
- backendsets
List<Get
Backend Sets Backendset> - The list of backendsets.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer StringId - filters
List<Get
Backend Sets Filter>
- backendsets
Get
Backend Sets Backendset[] - The list of backendsets.
- id string
- The provider-assigned unique ID for this managed resource.
- load
Balancer stringId - filters
Get
Backend Sets Filter[]
- backendsets
Sequence[loadbalancer.
Get Backend Sets Backendset] - The list of backendsets.
- id str
- The provider-assigned unique ID for this managed resource.
- load_
balancer_ strid - filters
Sequence[loadbalancer.
Get Backend Sets Filter]
- backendsets List<Property Map>
- The list of backendsets.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer StringId - filters List<Property Map>
Supporting Types
GetBackendSetsBackendset
- 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
List<Get
Backend Sets Backendset Backend> - Health
Checkers List<GetBackend Sets Backendset Health Checker> - The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- List<Get
Backend Sets Backendset Lb Cookie Session Persistence Configuration> - The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Load
Balancer 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
- Session
Persistence 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).
- Ssl
Configurations List<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
[]Get
Backend Sets Backendset Backend - Health
Checkers []GetBackend Sets Backendset Health Checker - The health check policy configuration. For more information, see Editing Health Check Policies.
- Id string
- []Get
Backend Sets Backendset Lb Cookie Session Persistence Configuration - The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Load
Balancer 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
- Session
Persistence []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 []GetBackend Sets Backendset Ssl Configuration - A listener's SSL handling configuration.
- State string
- backend
Max 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<Get
Backend Sets Backendset Backend> - health
Checkers List<GetBackend Sets Backendset Health Checker> - The health check policy configuration. For more information, see Editing Health Check Policies.
- id String
- List<Get
Backend Sets Backendset Lb Cookie Session Persistence Configuration> - The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load
Balancer 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
- session
Persistence 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).
- ssl
Configurations List<GetBackend Sets Backendset Ssl Configuration> - A listener's SSL handling configuration.
- state String
- backend
Max 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
Get
Backend Sets Backendset Backend[] - health
Checkers GetBackend Sets Backendset Health Checker[] - The health check policy configuration. For more information, see Editing Health Check Policies.
- id string
- Get
Backend Sets Backendset Lb Cookie Session Persistence Configuration[] - The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load
Balancer 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
- session
Persistence 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 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[loadbalancer.
Get Backend Sets Backendset Backend] - health_
checkers Sequence[loadbalancer.Get Backend Sets Backendset Health Checker] - The health check policy configuration. For more information, see Editing Health Check Policies.
- id str
- Sequence[loadbalancer.
Get Backend 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[loadbalancer.configurations Get 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[loadbalancer.Get Backend Sets Backendset Ssl Configuration] - A listener's SSL handling configuration.
- state str
- backend
Max 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>
- health
Checkers 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).
- load
Balancer 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
- session
Persistence List<Property Map>Configurations - The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configurations 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
- Ip
Address string - 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 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
Backend
object. 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
- Ip
Address string - 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 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
Backend
object. 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
- ip
Address String - The IP address of the backend server. Example:
10.0.0.3
- max
Connections 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
Backend
object. 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
- ip
Address string - The IP address of the backend server. Example:
10.0.0.3
- max
Connections 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
Backend
object. 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
Backend
object. 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
- ip
Address String - The IP address of the backend server. Example:
10.0.0.3
- max
Connections 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
Backend
object. 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
- 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
Backend
object. Example:8080
- Protocol string
- The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- Response
Body 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
- 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 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
Backend
object. Example:8080
- Protocol string
- The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- Response
Body 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
- 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 string - The path against which to run the health check. Example:
/healthcheck
- interval
Ms Integer - The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example:
10000
- is
Force 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
Backend
object. Example:8080
- protocol String
- The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- response
Body 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
- return
Code 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
- 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. Defaults to 3000 (3 seconds). Example:
3000
- url
Path String - The path against which to run the health check. Example:
/healthcheck
- interval
Ms number - The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example:
10000
- is
Force 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
Backend
object. Example:8080
- protocol string
- The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- response
Body 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
- return
Code 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
- 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. Defaults to 3000 (3 seconds). Example:
3000
- url
Path 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
Backend
object. 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
- interval
Ms Number - The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example:
10000
- is
Force 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
Backend
object. Example:8080
- protocol String
- The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- response
Body 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
- return
Code 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
- 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. Defaults to 3000 (3 seconds). Example:
3000
- url
Path 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
- 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 string
- The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - Is
Http boolOnly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, 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-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - Path string
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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
- 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 string
- The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - Is
Http boolOnly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, 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-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - Path string
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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
- disable
Fallback 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-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - is
Http BooleanOnly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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 Boolean - Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol. - max
Age IntegerIn Seconds - The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - path String
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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
- disable
Fallback 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-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - is
Http booleanOnly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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 boolean - Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol. - max
Age numberIn Seconds - The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - path string
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - is_
http_ boolonly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, 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-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - path str
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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
- disable
Fallback 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-cookie
header inserted by the load balancer contains a domain attribute with the specified value. - is
Http BooleanOnly - Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, 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 Boolean - Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol. - max
Age NumberIn Seconds - The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value. - path String
- The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute 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
- 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
- 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
- disable
Fallback 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
- disable
Fallback 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
- disable
Fallback 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
- Certificate
Ids 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]
- Certificate
Name 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
- Cipher
Suite 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.
- Server
Order 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]
- 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
- Certificate
Ids []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]
- Certificate
Name 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
- Cipher
Suite 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.
- Server
Order 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]
- 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
- certificate
Ids 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]
- certificate
Name 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
- cipher
Suite 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.
- server
Order 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]
- verify
Depth Integer - The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer BooleanCertificate - Whether the load balancer listener should verify peer certificates. Example:
true
- certificate
Ids 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]
- certificate
Name 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
- cipher
Suite 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.
- server
Order 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]
- verify
Depth number - The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer 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
- certificate
Ids 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]
- certificate
Name 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
- cipher
Suite 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.
- server
Order 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]
- verify
Depth Number - The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer 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
oci
Terraform Provider.