oci.LoadBalancer.BackendSet
This resource provides the Backend Set resource in Oracle Cloud Infrastructure Load Balancer service.
Adds a backend set to a load balancer.
Supported Aliases
oci_load_balancer_backendset
Example Usage
using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testBackendSet = new Oci.LoadBalancer.BackendSet("testBackendSet", new()
{
HealthChecker = new Oci.LoadBalancer.Inputs.BackendSetHealthCheckerArgs
{
Protocol = @var.Backend_set_health_checker_protocol,
IntervalMs = @var.Backend_set_health_checker_interval_ms,
Port = @var.Backend_set_health_checker_port,
ResponseBodyRegex = @var.Backend_set_health_checker_response_body_regex,
Retries = @var.Backend_set_health_checker_retries,
ReturnCode = @var.Backend_set_health_checker_return_code,
TimeoutInMillis = @var.Backend_set_health_checker_timeout_in_millis,
UrlPath = @var.Backend_set_health_checker_url_path,
},
LoadBalancerId = oci_load_balancer_load_balancer.Test_load_balancer.Id,
Policy = @var.Backend_set_policy,
LbCookieSessionPersistenceConfiguration = new Oci.LoadBalancer.Inputs.BackendSetLbCookieSessionPersistenceConfigurationArgs
{
CookieName = @var.Backend_set_lb_cookie_session_persistence_configuration_cookie_name,
DisableFallback = @var.Backend_set_lb_cookie_session_persistence_configuration_disable_fallback,
Domain = @var.Backend_set_lb_cookie_session_persistence_configuration_domain,
IsHttpOnly = @var.Backend_set_lb_cookie_session_persistence_configuration_is_http_only,
IsSecure = @var.Backend_set_lb_cookie_session_persistence_configuration_is_secure,
MaxAgeInSeconds = @var.Backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds,
Path = @var.Backend_set_lb_cookie_session_persistence_configuration_path,
},
SessionPersistenceConfiguration = new Oci.LoadBalancer.Inputs.BackendSetSessionPersistenceConfigurationArgs
{
CookieName = @var.Backend_set_session_persistence_configuration_cookie_name,
DisableFallback = @var.Backend_set_session_persistence_configuration_disable_fallback,
},
SslConfiguration = new Oci.LoadBalancer.Inputs.BackendSetSslConfigurationArgs
{
CertificateIds = @var.Backend_set_ssl_configuration_certificate_ids,
CertificateName = oci_load_balancer_certificate.Test_certificate.Name,
CipherSuiteName = @var.Backend_set_ssl_configuration_cipher_suite_name,
Protocols = @var.Backend_set_ssl_configuration_protocols,
ServerOrderPreference = @var.Backend_set_ssl_configuration_server_order_preference,
TrustedCertificateAuthorityIds = @var.Backend_set_ssl_configuration_trusted_certificate_authority_ids,
VerifyDepth = @var.Backend_set_ssl_configuration_verify_depth,
VerifyPeerCertificate = @var.Backend_set_ssl_configuration_verify_peer_certificate,
},
});
});
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.NewBackendSet(ctx, "testBackendSet", &LoadBalancer.BackendSetArgs{
HealthChecker: &loadbalancer.BackendSetHealthCheckerArgs{
Protocol: pulumi.Any(_var.Backend_set_health_checker_protocol),
IntervalMs: pulumi.Any(_var.Backend_set_health_checker_interval_ms),
Port: pulumi.Any(_var.Backend_set_health_checker_port),
ResponseBodyRegex: pulumi.Any(_var.Backend_set_health_checker_response_body_regex),
Retries: pulumi.Any(_var.Backend_set_health_checker_retries),
ReturnCode: pulumi.Any(_var.Backend_set_health_checker_return_code),
TimeoutInMillis: pulumi.Any(_var.Backend_set_health_checker_timeout_in_millis),
UrlPath: pulumi.Any(_var.Backend_set_health_checker_url_path),
},
LoadBalancerId: pulumi.Any(oci_load_balancer_load_balancer.Test_load_balancer.Id),
Policy: pulumi.Any(_var.Backend_set_policy),
LbCookieSessionPersistenceConfiguration: &loadbalancer.BackendSetLbCookieSessionPersistenceConfigurationArgs{
CookieName: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_cookie_name),
DisableFallback: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_disable_fallback),
Domain: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_domain),
IsHttpOnly: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_is_http_only),
IsSecure: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_is_secure),
MaxAgeInSeconds: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds),
Path: pulumi.Any(_var.Backend_set_lb_cookie_session_persistence_configuration_path),
},
SessionPersistenceConfiguration: &loadbalancer.BackendSetSessionPersistenceConfigurationArgs{
CookieName: pulumi.Any(_var.Backend_set_session_persistence_configuration_cookie_name),
DisableFallback: pulumi.Any(_var.Backend_set_session_persistence_configuration_disable_fallback),
},
SslConfiguration: &loadbalancer.BackendSetSslConfigurationArgs{
CertificateIds: pulumi.Any(_var.Backend_set_ssl_configuration_certificate_ids),
CertificateName: pulumi.Any(oci_load_balancer_certificate.Test_certificate.Name),
CipherSuiteName: pulumi.Any(_var.Backend_set_ssl_configuration_cipher_suite_name),
Protocols: pulumi.Any(_var.Backend_set_ssl_configuration_protocols),
ServerOrderPreference: pulumi.Any(_var.Backend_set_ssl_configuration_server_order_preference),
TrustedCertificateAuthorityIds: pulumi.Any(_var.Backend_set_ssl_configuration_trusted_certificate_authority_ids),
VerifyDepth: pulumi.Any(_var.Backend_set_ssl_configuration_verify_depth),
VerifyPeerCertificate: pulumi.Any(_var.Backend_set_ssl_configuration_verify_peer_certificate),
},
})
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.BackendSet;
import com.pulumi.oci.LoadBalancer.BackendSetArgs;
import com.pulumi.oci.LoadBalancer.inputs.BackendSetHealthCheckerArgs;
import com.pulumi.oci.LoadBalancer.inputs.BackendSetLbCookieSessionPersistenceConfigurationArgs;
import com.pulumi.oci.LoadBalancer.inputs.BackendSetSessionPersistenceConfigurationArgs;
import com.pulumi.oci.LoadBalancer.inputs.BackendSetSslConfigurationArgs;
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) {
var testBackendSet = new BackendSet("testBackendSet", BackendSetArgs.builder()
.healthChecker(BackendSetHealthCheckerArgs.builder()
.protocol(var_.backend_set_health_checker_protocol())
.intervalMs(var_.backend_set_health_checker_interval_ms())
.port(var_.backend_set_health_checker_port())
.responseBodyRegex(var_.backend_set_health_checker_response_body_regex())
.retries(var_.backend_set_health_checker_retries())
.returnCode(var_.backend_set_health_checker_return_code())
.timeoutInMillis(var_.backend_set_health_checker_timeout_in_millis())
.urlPath(var_.backend_set_health_checker_url_path())
.build())
.loadBalancerId(oci_load_balancer_load_balancer.test_load_balancer().id())
.policy(var_.backend_set_policy())
.lbCookieSessionPersistenceConfiguration(BackendSetLbCookieSessionPersistenceConfigurationArgs.builder()
.cookieName(var_.backend_set_lb_cookie_session_persistence_configuration_cookie_name())
.disableFallback(var_.backend_set_lb_cookie_session_persistence_configuration_disable_fallback())
.domain(var_.backend_set_lb_cookie_session_persistence_configuration_domain())
.isHttpOnly(var_.backend_set_lb_cookie_session_persistence_configuration_is_http_only())
.isSecure(var_.backend_set_lb_cookie_session_persistence_configuration_is_secure())
.maxAgeInSeconds(var_.backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds())
.path(var_.backend_set_lb_cookie_session_persistence_configuration_path())
.build())
.sessionPersistenceConfiguration(BackendSetSessionPersistenceConfigurationArgs.builder()
.cookieName(var_.backend_set_session_persistence_configuration_cookie_name())
.disableFallback(var_.backend_set_session_persistence_configuration_disable_fallback())
.build())
.sslConfiguration(BackendSetSslConfigurationArgs.builder()
.certificateIds(var_.backend_set_ssl_configuration_certificate_ids())
.certificateName(oci_load_balancer_certificate.test_certificate().name())
.cipherSuiteName(var_.backend_set_ssl_configuration_cipher_suite_name())
.protocols(var_.backend_set_ssl_configuration_protocols())
.serverOrderPreference(var_.backend_set_ssl_configuration_server_order_preference())
.trustedCertificateAuthorityIds(var_.backend_set_ssl_configuration_trusted_certificate_authority_ids())
.verifyDepth(var_.backend_set_ssl_configuration_verify_depth())
.verifyPeerCertificate(var_.backend_set_ssl_configuration_verify_peer_certificate())
.build())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_backend_set = oci.load_balancer.BackendSet("testBackendSet",
health_checker=oci.load_balancer.BackendSetHealthCheckerArgs(
protocol=var["backend_set_health_checker_protocol"],
interval_ms=var["backend_set_health_checker_interval_ms"],
port=var["backend_set_health_checker_port"],
response_body_regex=var["backend_set_health_checker_response_body_regex"],
retries=var["backend_set_health_checker_retries"],
return_code=var["backend_set_health_checker_return_code"],
timeout_in_millis=var["backend_set_health_checker_timeout_in_millis"],
url_path=var["backend_set_health_checker_url_path"],
),
load_balancer_id=oci_load_balancer_load_balancer["test_load_balancer"]["id"],
policy=var["backend_set_policy"],
lb_cookie_session_persistence_configuration=oci.load_balancer.BackendSetLbCookieSessionPersistenceConfigurationArgs(
cookie_name=var["backend_set_lb_cookie_session_persistence_configuration_cookie_name"],
disable_fallback=var["backend_set_lb_cookie_session_persistence_configuration_disable_fallback"],
domain=var["backend_set_lb_cookie_session_persistence_configuration_domain"],
is_http_only=var["backend_set_lb_cookie_session_persistence_configuration_is_http_only"],
is_secure=var["backend_set_lb_cookie_session_persistence_configuration_is_secure"],
max_age_in_seconds=var["backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds"],
path=var["backend_set_lb_cookie_session_persistence_configuration_path"],
),
session_persistence_configuration=oci.load_balancer.BackendSetSessionPersistenceConfigurationArgs(
cookie_name=var["backend_set_session_persistence_configuration_cookie_name"],
disable_fallback=var["backend_set_session_persistence_configuration_disable_fallback"],
),
ssl_configuration=oci.load_balancer.BackendSetSslConfigurationArgs(
certificate_ids=var["backend_set_ssl_configuration_certificate_ids"],
certificate_name=oci_load_balancer_certificate["test_certificate"]["name"],
cipher_suite_name=var["backend_set_ssl_configuration_cipher_suite_name"],
protocols=var["backend_set_ssl_configuration_protocols"],
server_order_preference=var["backend_set_ssl_configuration_server_order_preference"],
trusted_certificate_authority_ids=var["backend_set_ssl_configuration_trusted_certificate_authority_ids"],
verify_depth=var["backend_set_ssl_configuration_verify_depth"],
verify_peer_certificate=var["backend_set_ssl_configuration_verify_peer_certificate"],
))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBackendSet = new oci.loadbalancer.BackendSet("testBackendSet", {
healthChecker: {
protocol: _var.backend_set_health_checker_protocol,
intervalMs: _var.backend_set_health_checker_interval_ms,
port: _var.backend_set_health_checker_port,
responseBodyRegex: _var.backend_set_health_checker_response_body_regex,
retries: _var.backend_set_health_checker_retries,
returnCode: _var.backend_set_health_checker_return_code,
timeoutInMillis: _var.backend_set_health_checker_timeout_in_millis,
urlPath: _var.backend_set_health_checker_url_path,
},
loadBalancerId: oci_load_balancer_load_balancer.test_load_balancer.id,
policy: _var.backend_set_policy,
lbCookieSessionPersistenceConfiguration: {
cookieName: _var.backend_set_lb_cookie_session_persistence_configuration_cookie_name,
disableFallback: _var.backend_set_lb_cookie_session_persistence_configuration_disable_fallback,
domain: _var.backend_set_lb_cookie_session_persistence_configuration_domain,
isHttpOnly: _var.backend_set_lb_cookie_session_persistence_configuration_is_http_only,
isSecure: _var.backend_set_lb_cookie_session_persistence_configuration_is_secure,
maxAgeInSeconds: _var.backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds,
path: _var.backend_set_lb_cookie_session_persistence_configuration_path,
},
sessionPersistenceConfiguration: {
cookieName: _var.backend_set_session_persistence_configuration_cookie_name,
disableFallback: _var.backend_set_session_persistence_configuration_disable_fallback,
},
sslConfiguration: {
certificateIds: _var.backend_set_ssl_configuration_certificate_ids,
certificateName: oci_load_balancer_certificate.test_certificate.name,
cipherSuiteName: _var.backend_set_ssl_configuration_cipher_suite_name,
protocols: _var.backend_set_ssl_configuration_protocols,
serverOrderPreference: _var.backend_set_ssl_configuration_server_order_preference,
trustedCertificateAuthorityIds: _var.backend_set_ssl_configuration_trusted_certificate_authority_ids,
verifyDepth: _var.backend_set_ssl_configuration_verify_depth,
verifyPeerCertificate: _var.backend_set_ssl_configuration_verify_peer_certificate,
},
});
resources:
testBackendSet:
type: oci:LoadBalancer:BackendSet
properties:
healthChecker:
protocol: ${var.backend_set_health_checker_protocol}
intervalMs: ${var.backend_set_health_checker_interval_ms}
port: ${var.backend_set_health_checker_port}
responseBodyRegex: ${var.backend_set_health_checker_response_body_regex}
retries: ${var.backend_set_health_checker_retries}
returnCode: ${var.backend_set_health_checker_return_code}
timeoutInMillis: ${var.backend_set_health_checker_timeout_in_millis}
urlPath: ${var.backend_set_health_checker_url_path}
loadBalancerId: ${oci_load_balancer_load_balancer.test_load_balancer.id}
policy: ${var.backend_set_policy}
lbCookieSessionPersistenceConfiguration:
cookieName: ${var.backend_set_lb_cookie_session_persistence_configuration_cookie_name}
disableFallback: ${var.backend_set_lb_cookie_session_persistence_configuration_disable_fallback}
domain: ${var.backend_set_lb_cookie_session_persistence_configuration_domain}
isHttpOnly: ${var.backend_set_lb_cookie_session_persistence_configuration_is_http_only}
isSecure: ${var.backend_set_lb_cookie_session_persistence_configuration_is_secure}
maxAgeInSeconds: ${var.backend_set_lb_cookie_session_persistence_configuration_max_age_in_seconds}
path: ${var.backend_set_lb_cookie_session_persistence_configuration_path}
sessionPersistenceConfiguration:
cookieName: ${var.backend_set_session_persistence_configuration_cookie_name}
disableFallback: ${var.backend_set_session_persistence_configuration_disable_fallback}
sslConfiguration:
certificateIds: ${var.backend_set_ssl_configuration_certificate_ids}
certificateName: ${oci_load_balancer_certificate.test_certificate.name}
cipherSuiteName: ${var.backend_set_ssl_configuration_cipher_suite_name}
protocols: ${var.backend_set_ssl_configuration_protocols}
serverOrderPreference: ${var.backend_set_ssl_configuration_server_order_preference}
trustedCertificateAuthorityIds: ${var.backend_set_ssl_configuration_trusted_certificate_authority_ids}
verifyDepth: ${var.backend_set_ssl_configuration_verify_depth}
verifyPeerCertificate: ${var.backend_set_ssl_configuration_verify_peer_certificate}
Create BackendSet Resource
new BackendSet(name: string, args: BackendSetArgs, opts?: CustomResourceOptions);
@overload
def BackendSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
health_checker: Optional[_loadbalancer.BackendSetHealthCheckerArgs] = None,
lb_cookie_session_persistence_configuration: Optional[_loadbalancer.BackendSetLbCookieSessionPersistenceConfigurationArgs] = None,
load_balancer_id: Optional[str] = None,
name: Optional[str] = None,
policy: Optional[str] = None,
session_persistence_configuration: Optional[_loadbalancer.BackendSetSessionPersistenceConfigurationArgs] = None,
ssl_configuration: Optional[_loadbalancer.BackendSetSslConfigurationArgs] = None)
@overload
def BackendSet(resource_name: str,
args: BackendSetArgs,
opts: Optional[ResourceOptions] = None)
func NewBackendSet(ctx *Context, name string, args BackendSetArgs, opts ...ResourceOption) (*BackendSet, error)
public BackendSet(string name, BackendSetArgs args, CustomResourceOptions? opts = null)
public BackendSet(String name, BackendSetArgs args)
public BackendSet(String name, BackendSetArgs args, CustomResourceOptions options)
type: oci:LoadBalancer:BackendSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackendSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BackendSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BackendSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackendSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackendSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
BackendSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The BackendSet resource accepts the following input properties:
- Health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- Policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- Session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- Ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- Health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- Policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- Session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- Ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- load
Balancer StringId The OCID of the load balancer on which to add a backend set.
- policy String
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- name String
A friendly name for the backend set. It must be unique and it cannot be changed.
- session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- health_
checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- load_
balancer_ strid The OCID of the load balancer on which to add a backend set.
- policy str
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- name str
A friendly name for the backend set. It must be unique and it cannot be changed.
- session_
persistence_ Backendconfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl_
configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- health
Checker Property Map (Updatable) The health check policy's configuration details.
- load
Balancer StringId The OCID of the load balancer on which to add a backend set.
- policy String
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Property Map
(Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- name String
A friendly name for the backend set. It must be unique and it cannot be changed.
- session
Persistence Property MapConfiguration (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration Property Map (Updatable) The load balancer's SSL handling configuration details.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackendSet resource produces the following output properties:
- Backends
List<Backend
Set Backend> - Id string
The provider-assigned unique ID for this managed resource.
- State string
- Backends
[]Backend
Set Backend - Id string
The provider-assigned unique ID for this managed resource.
- State string
- backends
List<Backend
Set Backend> - id String
The provider-assigned unique ID for this managed resource.
- state String
- backends
Backend
Set Backend[] - id string
The provider-assigned unique ID for this managed resource.
- state string
- backends
Backend
Set Backend] - id str
The provider-assigned unique ID for this managed resource.
- state str
- backends List<Property Map>
- id String
The provider-assigned unique ID for this managed resource.
- state String
Look up Existing BackendSet Resource
Get an existing BackendSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BackendSetState, opts?: CustomResourceOptions): BackendSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backends: Optional[Sequence[_loadbalancer.BackendSetBackendArgs]] = None,
health_checker: Optional[_loadbalancer.BackendSetHealthCheckerArgs] = None,
lb_cookie_session_persistence_configuration: Optional[_loadbalancer.BackendSetLbCookieSessionPersistenceConfigurationArgs] = None,
load_balancer_id: Optional[str] = None,
name: Optional[str] = None,
policy: Optional[str] = None,
session_persistence_configuration: Optional[_loadbalancer.BackendSetSessionPersistenceConfigurationArgs] = None,
ssl_configuration: Optional[_loadbalancer.BackendSetSslConfigurationArgs] = None,
state: Optional[str] = None) -> BackendSet
func GetBackendSet(ctx *Context, name string, id IDInput, state *BackendSetState, opts ...ResourceOption) (*BackendSet, error)
public static BackendSet Get(string name, Input<string> id, BackendSetState? state, CustomResourceOptions? opts = null)
public static BackendSet get(String name, Output<String> id, BackendSetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Backends
List<Backend
Set Backend Args> - Health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- Name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- Policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- Ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- State string
- Backends
[]Backend
Set Backend Args - Health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- Load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- Name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- Policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- Session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- Ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- State string
- backends
List<Backend
Set Backend Args> - health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load
Balancer StringId The OCID of the load balancer on which to add a backend set.
- name String
A friendly name for the backend set. It must be unique and it cannot be changed.
- policy String
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- state String
- backends
Backend
Set Backend Args[] - health
Checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load
Balancer stringId The OCID of the load balancer on which to add a backend set.
- name string
A friendly name for the backend set. It must be unique and it cannot be changed.
- policy string
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- session
Persistence BackendConfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- state string
- backends
Backend
Set Backend Args] - health_
checker BackendSet Health Checker Args (Updatable) The health check policy's configuration details.
- Backend
Set Lb Cookie Session Persistence Configuration Args (Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load_
balancer_ strid The OCID of the load balancer on which to add a backend set.
- name str
A friendly name for the backend set. It must be unique and it cannot be changed.
- policy str
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- session_
persistence_ Backendconfiguration Set Session Persistence Configuration Args (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl_
configuration BackendSet Ssl Configuration Args (Updatable) The load balancer's SSL handling configuration details.
- state str
- backends List<Property Map>
- health
Checker Property Map (Updatable) The health check policy's configuration details.
- Property Map
(Updatable) The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
- load
Balancer StringId The OCID of the load balancer on which to add a backend set.
- name String
A friendly name for the backend set. It must be unique and it cannot be changed.
- policy String
(Updatable) The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example:
LEAST_CONNECTIONS
- session
Persistence Property MapConfiguration (Updatable) The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
- ssl
Configuration Property Map (Updatable) The load balancer's SSL handling configuration details.
- state String
Supporting Types
BackendSetBackend
- Ip
Address string The IP address of the backend server. Example:
10.0.0.3
- Port int
(Updatable) 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
- 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
- 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
- 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
- Ip
Address string The IP address of the backend server. Example:
10.0.0.3
- Port int
(Updatable) 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
- 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
- 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
- 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
- ip
Address String The IP address of the backend server. Example:
10.0.0.3
- port Integer
(Updatable) 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
- 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
- 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
- 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
- ip
Address string The IP address of the backend server. Example:
10.0.0.3
- port number
(Updatable) 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
- 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
- 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
- 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
- ip_
address str The IP address of the backend server. Example:
10.0.0.3
- port int
(Updatable) 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
- 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
- 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
- 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
- ip
Address String The IP address of the backend server. Example:
10.0.0.3
- port Number
(Updatable) 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
- 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
- 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
- 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
BackendSetHealthChecker
- Protocol string
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- Interval
Ms int (Updatable) The interval between health checks, in milliseconds. Example:
10000
- Port int
(Updatable) 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
- Response
Body stringRegex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- Retries int
(Updatable) 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. Example:
3
- Return
Code int (Updatable) The status code a healthy backend server should return. Example:
200
- Timeout
In intMillis (Updatable) 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. Example:
3000
- Url
Path string (Updatable) The path against which to run the health check. Example:
/healthcheck
- Protocol string
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- Interval
Ms int (Updatable) The interval between health checks, in milliseconds. Example:
10000
- Port int
(Updatable) 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
- Response
Body stringRegex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- Retries int
(Updatable) 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. Example:
3
- Return
Code int (Updatable) The status code a healthy backend server should return. Example:
200
- Timeout
In intMillis (Updatable) 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. Example:
3000
- Url
Path string (Updatable) The path against which to run the health check. Example:
/healthcheck
- protocol String
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- interval
Ms Integer (Updatable) The interval between health checks, in milliseconds. Example:
10000
- port Integer
(Updatable) 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
- response
Body StringRegex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- retries Integer
(Updatable) 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. Example:
3
- return
Code Integer (Updatable) The status code a healthy backend server should return. Example:
200
- timeout
In IntegerMillis (Updatable) 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. Example:
3000
- url
Path String (Updatable) The path against which to run the health check. Example:
/healthcheck
- protocol string
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- interval
Ms number (Updatable) The interval between health checks, in milliseconds. Example:
10000
- port number
(Updatable) 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
- response
Body stringRegex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- retries number
(Updatable) 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. Example:
3
- return
Code number (Updatable) The status code a healthy backend server should return. Example:
200
- timeout
In numberMillis (Updatable) 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. Example:
3000
- url
Path string (Updatable) The path against which to run the health check. Example:
/healthcheck
- protocol str
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- interval_
ms int (Updatable) The interval between health checks, in milliseconds. Example:
10000
- port int
(Updatable) 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
- response_
body_ strregex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- retries int
(Updatable) 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. Example:
3
- return_
code int (Updatable) The status code a healthy backend server should return. Example:
200
- timeout_
in_ intmillis (Updatable) 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. Example:
3000
- url_
path str (Updatable) The path against which to run the health check. Example:
/healthcheck
- protocol String
(Updatable) The protocol the health check must use; either HTTP or TCP. Example:
HTTP
- interval
Ms Number (Updatable) The interval between health checks, in milliseconds. Example:
10000
- port Number
(Updatable) 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
- response
Body StringRegex (Updatable) A regular expression for parsing the response body from the backend server. Example:
^((?!false).|\s)*$
- retries Number
(Updatable) 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. Example:
3
- return
Code Number (Updatable) The status code a healthy backend server should return. Example:
200
- timeout
In NumberMillis (Updatable) 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. Example:
3000
- url
Path String (Updatable) The path against which to run the health check. Example:
/healthcheck
BackendSetLbCookieSessionPersistenceConfiguration
- string
(Updatable) 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 (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- Is
Http boolOnly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- Is
Secure bool (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- Max
Age intIn Seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- Path string
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
- string
(Updatable) 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 (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- Is
Http boolOnly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- Is
Secure bool (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- Max
Age intIn Seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- Path string
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
- String
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback Boolean (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- is
Http BooleanOnly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- is
Secure Boolean (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- max
Age IntegerIn Seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- path String
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
- string
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback boolean (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- is
Http booleanOnly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- is
Secure boolean (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- max
Age numberIn Seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- path string
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
- str
(Updatable) 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 (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- is_
http_ boolonly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- is_
secure bool (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- max_
age_ intin_ seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- path str
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
- String
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback Boolean (Updatable) 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
(Updatable) The domain in which the cookie is valid. The
Set-cookie
header inserted by the load balancer contains a domain attribute with the specified value.- is
Http BooleanOnly (Updatable) Whether the
Set-cookie
header should contain theHttpOnly
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theHttpOnly
attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example:true
- is
Secure Boolean (Updatable) Whether the
Set-cookie
header should contain theSecure
attribute. Iftrue
, theSet-cookie
header inserted by the load balancer contains theSecure
attribute, which directs the client or browser to send the cookie only using a secure protocol.- max
Age NumberIn Seconds (Updatable) The amount of time the cookie remains valid. The
Set-cookie
header inserted by the load balancer contains aMax-Age
attribute with the specified value.- path String
(Updatable) The path in which the cookie is valid. The
Set-cookie header
inserted by the load balancer contains aPath
attribute with the specified value.
BackendSetSessionPersistenceConfiguration
- string
(Updatable) 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 (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example:
false
- string
(Updatable) 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 (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example:
false
- String
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback Boolean (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example:
false
- string
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback boolean (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example:
false
- str
(Updatable) 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 (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example:
false
- String
(Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example:
example_cookie
- disable
Fallback Boolean (Updatable) 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
BackendSetSslConfiguration
- Certificate
Ids List<string> (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example:
[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- Certificate
Name string (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- Cipher
Suite stringName (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- Protocols List<string>
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- Server
Order stringPreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<string>
(Updatable) 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 (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- Verify
Peer boolCertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
- Certificate
Ids []string (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example:
[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- Certificate
Name string (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- Cipher
Suite stringName (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- Protocols []string
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- Server
Order stringPreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- []string
(Updatable) 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 (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- Verify
Peer boolCertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
- certificate
Ids List<String> (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example:
[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificate
Name String (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- cipher
Suite StringName (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- protocols List<String>
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- server
Order StringPreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<String>
(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example:
[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verify
Depth Integer (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer BooleanCertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
- certificate
Ids string[] (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example:
[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificate
Name string (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- cipher
Suite stringName (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- protocols string[]
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- server
Order stringPreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- string[]
(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example:
[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verify
Depth number (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer booleanCertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
- certificate_
ids Sequence[str] (Updatable) 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 (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- cipher_
suite_ strname (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- protocols Sequence[str]
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- server_
order_ strpreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- Sequence[str]
(Updatable) 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 (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- verify_
peer_ boolcertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
- certificate
Ids List<String> (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example:
[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]
- certificate
Name String (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example:
example_certificate_bundle
- cipher
Suite StringName (Updatable) The name of the cipher suite to use for HTTPS or SSL connections.
- protocols List<String>
(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
- server
Order StringPreference (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
- List<String>
(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example:
[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]
- verify
Depth Number (Updatable) The maximum depth for peer certificate chain verification. Example:
3
- verify
Peer BooleanCertificate (Updatable) Whether the load balancer listener should verify peer certificates. Example:
true
Import
BackendSets can be imported using the id
, e.g.
$ pulumi import oci:LoadBalancer/backendSet:BackendSet test_backend_set "loadBalancers/{loadBalancerId}/backendSets/{backendSetName}"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.