1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. getBackendSets
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.LoadBalancer.getBackendSets

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    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

    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 = oci_load_balancer_load_balancer.Test_load_balancer.Id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/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: oci_load_balancer_load_balancer.Test_load_balancer.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.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(oci_load_balancer_load_balancer.test_load_balancer().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_backend_sets = oci.LoadBalancer.get_backend_sets(load_balancer_id=oci_load_balancer_load_balancer["test_load_balancer"]["id"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBackendSets = oci.LoadBalancer.getBackendSets({
        loadBalancerId: oci_load_balancer_load_balancer.test_load_balancer.id,
    });
    
    variables:
      testBackendSets:
        fn::invoke:
          Function: oci:LoadBalancer:getBackendSets
          Arguments:
            loadBalancerId: ${oci_load_balancer_load_balancer.test_load_balancer.id}
    

    Using getBackendSets

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBackendSets(args: GetBackendSetsArgs, opts?: InvokeOptions): Promise<GetBackendSetsResult>
    function getBackendSetsOutput(args: GetBackendSetsOutputArgs, opts?: InvokeOptions): Output<GetBackendSetsResult>
    def get_backend_sets(filters: Optional[Sequence[_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:

    LoadBalancerId string
    The OCID of the load balancer associated with the backend sets to retrieve.
    Filters List<GetBackendSetsFilter>
    LoadBalancerId string
    The OCID of the load balancer associated with the backend sets to retrieve.
    Filters []GetBackendSetsFilter
    loadBalancerId String
    The OCID of the load balancer associated with the backend sets to retrieve.
    filters List<GetBackendSetsFilter>
    loadBalancerId string
    The OCID of the load balancer associated with the backend sets to retrieve.
    filters GetBackendSetsFilter[]
    load_balancer_id str
    The OCID of the load balancer associated with the backend sets to retrieve.
    filters GetBackendSetsFilter]
    loadBalancerId String
    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<GetBackendSetsBackendset>
    The list of backendsets.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    Filters List<GetBackendSetsFilter>
    Backendsets []GetBackendSetsBackendset
    The list of backendsets.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    Filters []GetBackendSetsFilter
    backendsets List<GetBackendSetsBackendset>
    The list of backendsets.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    filters List<GetBackendSetsFilter>
    backendsets GetBackendSetsBackendset[]
    The list of backendsets.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerId string
    filters GetBackendSetsFilter[]
    backendsets GetBackendSetsBackendset]
    The list of backendsets.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_id str
    filters GetBackendSetsFilter]
    backendsets List<Property Map>
    The list of backendsets.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    filters List<Property Map>

    Supporting Types

    GetBackendSetsBackendset

    Backends List<GetBackendSetsBackendsetBackend>
    HealthCheckers List<GetBackendSetsBackendsetHealthChecker>
    The health check policy configuration. For more information, see Editing Health Check Policies.
    Id string
    LbCookieSessionPersistenceConfigurations List<GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration>
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    LoadBalancerId string
    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
    SessionPersistenceConfigurations List<GetBackendSetsBackendsetSessionPersistenceConfiguration>
    The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
    SslConfigurations List<GetBackendSetsBackendsetSslConfiguration>
    A listener's SSL handling configuration.
    State string
    Backends []GetBackendSetsBackendsetBackend
    HealthCheckers []GetBackendSetsBackendsetHealthChecker
    The health check policy configuration. For more information, see Editing Health Check Policies.
    Id string
    LbCookieSessionPersistenceConfigurations []GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    LoadBalancerId string
    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
    SessionPersistenceConfigurations []GetBackendSetsBackendsetSessionPersistenceConfiguration
    The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
    SslConfigurations []GetBackendSetsBackendsetSslConfiguration
    A listener's SSL handling configuration.
    State string
    backends List<GetBackendSetsBackendsetBackend>
    healthCheckers List<GetBackendSetsBackendsetHealthChecker>
    The health check policy configuration. For more information, see Editing Health Check Policies.
    id String
    lbCookieSessionPersistenceConfigurations List<GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration>
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    loadBalancerId String
    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
    sessionPersistenceConfigurations List<GetBackendSetsBackendsetSessionPersistenceConfiguration>
    The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
    sslConfigurations List<GetBackendSetsBackendsetSslConfiguration>
    A listener's SSL handling configuration.
    state String
    backends GetBackendSetsBackendsetBackend[]
    healthCheckers GetBackendSetsBackendsetHealthChecker[]
    The health check policy configuration. For more information, see Editing Health Check Policies.
    id string
    lbCookieSessionPersistenceConfigurations GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration[]
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    loadBalancerId string
    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
    sessionPersistenceConfigurations GetBackendSetsBackendsetSessionPersistenceConfiguration[]
    The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
    sslConfigurations GetBackendSetsBackendsetSslConfiguration[]
    A listener's SSL handling configuration.
    state string
    backends GetBackendSetsBackendsetBackend]
    health_checkers GetBackendSetsBackendsetHealthChecker]
    The health check policy configuration. For more information, see Editing Health Check Policies.
    id str
    lb_cookie_session_persistence_configurations GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration]
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    load_balancer_id str
    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_configurations GetBackendSetsBackendsetSessionPersistenceConfiguration]
    The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
    ssl_configurations GetBackendSetsBackendsetSslConfiguration]
    A listener's SSL handling configuration.
    state str
    backends List<Property Map>
    healthCheckers List<Property Map>
    The health check policy configuration. For more information, see Editing Health Check Policies.
    id String
    lbCookieSessionPersistenceConfigurations List<Property Map>
    The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
    loadBalancerId String
    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
    sessionPersistenceConfigurations List<Property Map>
    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
    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
    IpAddress string
    The IP address of the backend server. Example: 10.0.0.3
    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
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    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
    ipAddress string
    The IP address of the backend server. Example: 10.0.0.3
    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
    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
    ipAddress String
    The IP address of the backend server. Example: 10.0.0.3
    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

    IntervalMs int
    The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: 10000
    IsForcePlainText bool
    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
    ResponseBodyRegex string
    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
    TimeoutInMillis int
    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
    IsForcePlainText bool
    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
    ResponseBodyRegex string
    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
    TimeoutInMillis int
    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
    isForcePlainText Boolean
    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
    responseBodyRegex String
    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
    timeoutInMillis Integer
    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
    isForcePlainText boolean
    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
    responseBodyRegex string
    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
    timeoutInMillis number
    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_plain_text bool
    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_regex str
    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_millis int
    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
    isForcePlainText Boolean
    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
    responseBodyRegex String
    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
    timeoutInMillis Number
    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

    CookieName 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-cookie header inserted by the load balancer contains a domain attribute with the specified value.
    IsHttpOnly bool
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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
    IsSecure bool
    Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    MaxAgeInSeconds int
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.
    CookieName 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-cookie header inserted by the load balancer contains a domain attribute with the specified value.
    IsHttpOnly bool
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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
    IsSecure bool
    Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    MaxAgeInSeconds int
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.
    cookieName 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-cookie header inserted by the load balancer contains a domain attribute with the specified value.
    isHttpOnly Boolean
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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
    isSecure Boolean
    Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    maxAgeInSeconds Integer
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.
    cookieName 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-cookie header inserted by the load balancer contains a domain attribute with the specified value.
    isHttpOnly boolean
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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
    isSecure boolean
    Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    maxAgeInSeconds number
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.
    cookie_name 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_only bool
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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 the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    max_age_in_seconds int
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.
    cookieName 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-cookie header inserted by the load balancer contains a domain attribute with the specified value.
    isHttpOnly Boolean
    Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly 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
    isSecure Boolean
    Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.
    maxAgeInSeconds Number
    The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-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 a Path attribute with the specified value.

    GetBackendSetsBackendsetSessionPersistenceConfiguration

    CookieName 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
    CookieName 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
    cookieName 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
    cookieName 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
    cookie_name 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
    cookieName 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
    CipherSuiteName string
    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.
    ServerOrderPreference string
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    TrustedCertificateAuthorityIds 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
    VerifyPeerCertificate bool
    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
    CipherSuiteName string
    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.
    ServerOrderPreference string
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    TrustedCertificateAuthorityIds []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
    VerifyPeerCertificate bool
    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
    cipherSuiteName String
    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.
    serverOrderPreference String
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    trustedCertificateAuthorityIds 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
    verifyPeerCertificate Boolean
    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
    cipherSuiteName string
    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.
    serverOrderPreference string
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    trustedCertificateAuthorityIds 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
    verifyPeerCertificate boolean
    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_name str
    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_preference str
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    trusted_certificate_authority_ids 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_certificate bool
    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
    cipherSuiteName String
    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.
    serverOrderPreference String
    When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
    trustedCertificateAuthorityIds 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
    verifyPeerCertificate Boolean
    Whether the load balancer listener should verify peer certificates. Example: true

    GetBackendSetsFilter

    Name string
    A friendly name for the backend set. It must be unique and it cannot be changed.
    Values List<string>
    Regex bool
    Name string
    A friendly name for the backend set. It must be unique and it cannot be changed.
    Values []string
    Regex bool
    name String
    A friendly name for the backend set. It must be unique and it cannot be changed.
    values List<String>
    regex Boolean
    name string
    A friendly name for the backend set. It must be unique and it cannot be changed.
    values string[]
    regex boolean
    name str
    A friendly name for the backend set. It must be unique and it cannot be changed.
    values Sequence[str]
    regex bool
    name String
    A friendly name for the backend set. It must be unique and it cannot be changed.
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi