import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Backend resource in Oracle Cloud Infrastructure Load Balancer service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/loadbalancer/latest/Backend * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/load_balancer * * Adds a backend server to a backend set. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testBackend = new oci.loadbalancer.Backend("test_backend", { * backendsetName: testBackendSet.name, * ipAddress: backendIpAddress, * loadBalancerId: testLoadBalancer.id, * port: Number(backendPort), * backup: backendBackup === "true", * drain: backendDrain === "true", * maxConnections: Number(backendMaxConnections), * offline: backendOffline === "true", * weight: Number(backendWeight), * }); * ``` * * ## Import * * Backends can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:LoadBalancer/backend:Backend test_backend "loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}" * ``` */ export declare class Backend extends pulumi.CustomResource { /** * Get an existing Backend resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: BackendState, opts?: pulumi.CustomResourceOptions): Backend; /** * Returns true if the given object is an instance of Backend. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Backend; /** * The name of the backend set to add the backend server to. Example: `exampleBackendSet` */ readonly backendsetName: pulumi.Output; /** * (Updatable) 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. * * **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. * * Example: `false` */ readonly backup: pulumi.Output; /** * (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ readonly drain: pulumi.Output; /** * The IP address of the backend server. Example: `10.0.0.3` */ readonly ipAddress: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. */ readonly loadBalancerId: pulumi.Output; /** * (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. * * If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. * * Example: `300` */ readonly maxConnections: pulumi.Output; /** * A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080` */ readonly name: pulumi.Output; /** * (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ readonly offline: pulumi.Output; /** * The communication port for the backend server. Example: `8080` */ readonly port: pulumi.Output; readonly state: pulumi.Output; /** * (Updatable) 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](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly weight: pulumi.Output; /** * Create a Backend resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: BackendArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Backend resources. */ export interface BackendState { /** * The name of the backend set to add the backend server to. Example: `exampleBackendSet` */ backendsetName?: pulumi.Input; /** * (Updatable) 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. * * **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. * * Example: `false` */ backup?: pulumi.Input; /** * (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ drain?: pulumi.Input; /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. */ loadBalancerId?: pulumi.Input; /** * (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. * * If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. * * Example: `300` */ maxConnections?: pulumi.Input; /** * A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080` */ name?: pulumi.Input; /** * (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ offline?: pulumi.Input; /** * The communication port for the backend server. Example: `8080` */ port?: pulumi.Input; state?: pulumi.Input; /** * (Updatable) 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](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ weight?: pulumi.Input; } /** * The set of arguments for constructing a Backend resource. */ export interface BackendArgs { /** * The name of the backend set to add the backend server to. Example: `exampleBackendSet` */ backendsetName: pulumi.Input; /** * (Updatable) 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. * * **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. * * Example: `false` */ backup?: pulumi.Input; /** * (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ drain?: pulumi.Input; /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. */ loadBalancerId: pulumi.Input; /** * (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. * * If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. * * Example: `300` */ maxConnections?: pulumi.Input; /** * (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ offline?: pulumi.Input; /** * The communication port for the backend server. Example: `8080` */ port: pulumi.Input; /** * (Updatable) 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](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ weight?: pulumi.Input; } //# sourceMappingURL=backend.d.ts.map