1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkLoadBalancer
  5. getBackendSet
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

oci.NetworkLoadBalancer.getBackendSet

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

    This data source provides details about a specific Backend Set resource in Oracle Cloud Infrastructure Network Load Balancer service.

    Retrieves the configuration information for the specified backend set.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancerFunctions;
    import com.pulumi.oci.NetworkLoadBalancer.inputs.GetBackendSetArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testBackendSet = NetworkLoadBalancerFunctions.getBackendSet(GetBackendSetArgs.builder()
                .backendSetName(oci_network_load_balancer_backend_set.test_backend_set().name())
                .networkLoadBalancerId(oci_network_load_balancer_network_load_balancer.test_network_load_balancer().id())
                .ipVersion(var_.backend_set_ip_version())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    variables:
      testBackendSet:
        fn::invoke:
          Function: oci:NetworkLoadBalancer:getBackendSet
          Arguments:
            backendSetName: ${oci_network_load_balancer_backend_set.test_backend_set.name}
            networkLoadBalancerId: ${oci_network_load_balancer_network_load_balancer.test_network_load_balancer.id}
            ipVersion: ${var.backend_set_ip_version}
    

    Using getBackendSet

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

    function getBackendSet(args: GetBackendSetArgs, opts?: InvokeOptions): Promise<GetBackendSetResult>
    function getBackendSetOutput(args: GetBackendSetOutputArgs, opts?: InvokeOptions): Output<GetBackendSetResult>
    def get_backend_set(backend_set_name: Optional[str] = None,
                        network_load_balancer_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackendSetResult
    def get_backend_set_output(backend_set_name: Optional[pulumi.Input[str]] = None,
                        network_load_balancer_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBackendSetResult]
    func GetBackendSet(ctx *Context, args *GetBackendSetArgs, opts ...InvokeOption) (*GetBackendSetResult, error)
    func GetBackendSetOutput(ctx *Context, args *GetBackendSetOutputArgs, opts ...InvokeOption) GetBackendSetResultOutput

    > Note: This function is named GetBackendSet in the Go SDK.

    public static class GetBackendSet 
    {
        public static Task<GetBackendSetResult> InvokeAsync(GetBackendSetArgs args, InvokeOptions? opts = null)
        public static Output<GetBackendSetResult> Invoke(GetBackendSetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackendSetResult> getBackendSet(GetBackendSetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:NetworkLoadBalancer/getBackendSet:getBackendSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BackendSetName string

    The name of the backend set to retrieve. Example: example_backend_set

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    BackendSetName string

    The name of the backend set to retrieve. Example: example_backend_set

    NetworkLoadBalancerId string

    The OCID of the network load balancer to update.

    backendSetName String

    The name of the backend set to retrieve. Example: example_backend_set

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    backendSetName string

    The name of the backend set to retrieve. Example: example_backend_set

    networkLoadBalancerId string

    The OCID of the network load balancer to update.

    backend_set_name str

    The name of the backend set to retrieve. Example: example_backend_set

    network_load_balancer_id str

    The OCID of the network load balancer to update.

    backendSetName String

    The name of the backend set to retrieve. Example: example_backend_set

    networkLoadBalancerId String

    The OCID of the network load balancer to update.

    getBackendSet Result

    The following output properties are available:

    BackendSetName string
    Backends List<GetBackendSetBackend>

    Array of backends.

    HealthCheckers List<GetBackendSetHealthChecker>

    The health check policy configuration. For more information, see Editing Health Check Policies.

    Id string
    IpVersion string

    IP version associated with the backend set.

    IsPreserveSource bool

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    NetworkLoadBalancerId string
    Policy string

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    BackendSetName string
    Backends []GetBackendSetBackend

    Array of backends.

    HealthCheckers []GetBackendSetHealthChecker

    The health check policy configuration. For more information, see Editing Health Check Policies.

    Id string
    IpVersion string

    IP version associated with the backend set.

    IsPreserveSource bool

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    NetworkLoadBalancerId string
    Policy string

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    backendSetName String
    backends List<GetBackendSetBackend>

    Array of backends.

    healthCheckers List<GetBackendSetHealthChecker>

    The health check policy configuration. For more information, see Editing Health Check Policies.

    id String
    ipVersion String

    IP version associated with the backend set.

    isPreserveSource Boolean

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    networkLoadBalancerId String
    policy String

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    backendSetName string
    backends GetBackendSetBackend[]

    Array of backends.

    healthCheckers GetBackendSetHealthChecker[]

    The health check policy configuration. For more information, see Editing Health Check Policies.

    id string
    ipVersion string

    IP version associated with the backend set.

    isPreserveSource boolean

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    networkLoadBalancerId string
    policy string

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    backend_set_name str
    backends GetBackendSetBackend]

    Array of backends.

    health_checkers GetBackendSetHealthChecker]

    The health check policy configuration. For more information, see Editing Health Check Policies.

    id str
    ip_version str

    IP version associated with the backend set.

    is_preserve_source bool

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name str

    A user-friendly name for the backend set that must be unique and cannot be changed.

    network_load_balancer_id str
    policy str

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    backendSetName String
    backends List<Property Map>

    Array of backends.

    healthCheckers List<Property Map>

    The health check policy configuration. For more information, see Editing Health Check Policies.

    id String
    ipVersion String

    IP version associated with the backend set.

    isPreserveSource Boolean

    If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    networkLoadBalancerId String
    policy String

    The network load balancer policy for the backend set. Example: FIVE_TUPLE

    Supporting Types

    GetBackendSetBackend

    IpAddress string

    The IP address of the backend server. Example: 10.0.0.3

    IsBackup bool

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    IsDrain bool

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    IsOffline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    TargetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    Weight int

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    IpAddress string

    The IP address of the backend server. Example: 10.0.0.3

    IsBackup bool

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    IsDrain bool

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    IsOffline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    Name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    Port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    TargetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    Weight int

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    ipAddress String

    The IP address of the backend server. Example: 10.0.0.3

    isBackup Boolean

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    isDrain Boolean

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline Boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    port Integer

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    targetId String

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight Integer

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    ipAddress string

    The IP address of the backend server. Example: 10.0.0.3

    isBackup boolean

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    isDrain boolean

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name string

    A user-friendly name for the backend set that must be unique and cannot be changed.

    port number

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    targetId string

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight number

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    ip_address str

    The IP address of the backend server. Example: 10.0.0.3

    is_backup bool

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    is_drain bool

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    is_offline bool

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name str

    A user-friendly name for the backend set that must be unique and cannot be changed.

    port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    target_id str

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight int

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    ipAddress String

    The IP address of the backend server. Example: 10.0.0.3

    isBackup Boolean

    Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: false

    isDrain Boolean

    Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic. Example: false

    isOffline Boolean

    Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

    name String

    A user-friendly name for the backend set that must be unique and cannot be changed.

    port Number

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    targetId String

    The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>

    weight Number

    The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work. Example: 3

    GetBackendSetHealthChecker

    IntervalInMillis int

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    Port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    Protocol string

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    RequestData string

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    ResponseBodyRegex string

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    ResponseData string

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    Retries int

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    ReturnCode int

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    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. The default value is 3000 (3 seconds). Example: 3000

    UrlPath string

    The path against which to run the health check. Example: /healthcheck

    IntervalInMillis int

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    Port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    Protocol string

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    RequestData string

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    ResponseBodyRegex string

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    ResponseData string

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    Retries int

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    ReturnCode int

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    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. The default value is 3000 (3 seconds). Example: 3000

    UrlPath string

    The path against which to run the health check. Example: /healthcheck

    intervalInMillis Integer

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port Integer

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    protocol String

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    requestData String

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex String

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData String

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries Integer

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode Integer

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    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. The default value is 3000 (3 seconds). Example: 3000

    urlPath String

    The path against which to run the health check. Example: /healthcheck

    intervalInMillis number

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port number

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    protocol string

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    requestData string

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex string

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData string

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries number

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode number

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    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. The default value is 3000 (3 seconds). Example: 3000

    urlPath string

    The path against which to run the health check. Example: /healthcheck

    interval_in_millis int

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port int

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    protocol str

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    request_data str

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    response_body_regex str

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    response_data str

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries int

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    return_code int

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    timeout_in_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. The default value is 3000 (3 seconds). Example: 3000

    url_path str

    The path against which to run the health check. Example: /healthcheck

    intervalInMillis Number

    The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: 10000

    port Number

    The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the Backend object. The port must be specified if the backend port is 0. Example: 8080

    protocol String

    The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: HTTP

    requestData String

    Base64 encoded pattern to be sent as UDP or TCP health check probe.

    responseBodyRegex String

    A regular expression for parsing the response body from the backend server. Example: ^((?!false).|\s)*$

    responseData String

    Base64 encoded pattern to be validated as UDP or TCP health check probe response.

    retries Number

    The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: 3

    returnCode Number

    The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: 200

    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. The default value is 3000 (3 seconds). Example: 3000

    urlPath String

    The path against which to run the health check. Example: /healthcheck

    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.11.0 published on Wednesday, Sep 27, 2023 by Pulumi