Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

An entity that represents an action to apply for a routing rule.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_action_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_action_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_action_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

An object that represents an action to apply to a listener.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_t (
    action varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

An object that represents the action of adding a header to a request. This rule applies only to HTTP listeners. **NOTES:** * If a matching header already exists in the request, the system removes all of its occurrences, and then adds the new header. * The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_add_http_request_header_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_add_http_request_header_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_add_http_request_header_rule_t (
    action varchar2,
    header varchar2,
    value varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_add_http_request_header_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

An object that represents the action of adding a header to a response. This rule applies only to HTTP listeners. **NOTES:** * If a matching header already exists in the response, the system removes all of its occurrences, and then adds the new header. * The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_add_http_response_header_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_add_http_response_header_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_add_http_response_header_rule_t (
    action varchar2,
    header varchar2,
    value varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_add_http_response_header_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

A condition to apply to an access control rule.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_condition_t FORCE AUTHID CURRENT_USER IS OBJECT (
  attribute_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_condition_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_condition_t (
    attribute_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Nested table type of dbms_cloud_oci_load_balancer_rule_condition_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_condition_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_rule_condition_t) NOT PERSISTABLE;

An object that represents the action of configuring an access control rule. Access control rules permit access to application resources based on user-specified match conditions. This rule applies only to HTTP listeners. **NOTES:** * If you do not specify any access control rules, the default rule is to allow all traffic. * If you add access control rules, the load balancer denies any traffic that does not match the rules. * Maximum of two match conditions can be specified in a rule. * You can specify this rule only with the following `RuleCondition` combinations: * `SOURCE_IP_ADDRESS` * `SOURCE_VCN_ID` * `SOURCE_VCN_ID\", \"SOURCE_VCN_IP_ADDRESS`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_allow_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  conditions dbms_cloud_oci_load_balancer_rule_condition_tbl,
  description varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_allow_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_allow_rule_t (
    action varchar2,
    conditions dbms_cloud_oci_load_balancer_rule_condition_tbl,
    description varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_allow_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  ip_address varchar2(32767),
  port number,
  weight number,
  drain number,
  backup number,
  l_offline number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_t (
    name varchar2,
    ip_address varchar2,
    port number,
    weight number,
    drain number,
    backup number,
    l_offline number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The load balancing configuration details of a backend server.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ip_address varchar2(32767),
  port number,
  weight number,
  backup number,
  drain number,
  l_offline number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_details_t (
    ip_address varchar2,
    port number,
    weight number,
    backup number,
    drain number,
    l_offline number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Information about a single backend server health check result reported by a load balancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_health_check_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  source_ip_address varchar2(32767),
  l_timestamp timestamp with time zone,
  health_check_status varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_check_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_check_result_t (
    subnet_id varchar2,
    source_ip_address varchar2,
    l_timestamp timestamp with time zone,
    health_check_status varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_health_check_result_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_health_check_result_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_health_check_result_t) NOT PERSISTABLE;

The health status of the specified backend server as reported by the primary and standby load balancers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_health_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  health_check_results dbms_cloud_oci_load_balancer_health_check_result_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_health_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_health_t (
    status varchar2,
    health_check_results dbms_cloud_oci_load_balancer_health_check_result_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_health_checker_t FORCE AUTHID CURRENT_USER IS OBJECT (
  protocol varchar2(32767),
  url_path varchar2(32767),
  port number,
  return_code number,
  retries number,
  timeout_in_millis number,
  interval_in_millis number,
  response_body_regex varchar2(32767),
  is_force_plain_text number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_checker_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_checker_t (
    protocol varchar2,
    url_path varchar2,
    port number,
    return_code number,
    retries number,
    timeout_in_millis number,
    interval_in_millis number,
    response_body_regex varchar2,
    is_force_plain_text number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A listener's SSL handling configuration. To use SSL, a listener must be associated with a CERTIFICATE Type. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ssl_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  verify_depth number,
  verify_peer_certificate number,
  trusted_certificate_authority_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  certificate_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  certificate_name varchar2(32767),
  server_order_preference varchar2(32767),
  cipher_suite_name varchar2(32767),
  protocols dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_configuration_t (
    verify_depth number,
    verify_peer_certificate number,
    trusted_certificate_authority_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    certificate_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    certificate_name varchar2,
    server_order_preference varchar2,
    cipher_suite_name varchar2,
    protocols dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness). Session persistence enables the Load Balancing service to direct any number of requests that originate from a single logical client to a single backend web server. For more information, see Session Persistence. With application cookie stickiness, the load balancer enables session persistence only when the response from a backend application server includes a `Set-cookie` header with the user-specified cookie name. To disable application cookie stickiness on a running load balancer, use the UPDATE_BACKEND_SET Function operation and specify `null` for the `SessionPersistenceConfigurationDetails` object. Example: `SessionPersistenceConfigurationDetails: null` **Note:** `SessionPersistenceConfigurationDetails` (application cookie stickiness) and `LBCookieSessionPersistenceConfigurationDetails` (LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cookie_name varchar2(32767),
  disable_fallback number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t (
    cookie_name varchar2,
    disable_fallback number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness). Session persistence enables the Load Balancing service to direct all requests that originate from a single logical client to a single backend web server. For more information, see Session Persistence. When you configure LB cookie stickiness, the load balancer inserts a cookie into the response. The parameters configured in the cookie enable session stickiness. This method is useful when you have applications and Web backend services that cannot generate their own cookies. Path route rules take precedence to determine the target backend server. The load balancer verifies that session stickiness is enabled for the backend server and that the cookie configuration (domain, path, and cookie hash) is valid for the target. The system ignores invalid cookies. To disable LB cookie stickiness on a running load balancer, use the UPDATE_BACKEND_SET Function operation and specify `null` for the `LBCookieSessionPersistenceConfigurationDetails` object. Example: `LBCookieSessionPersistenceConfigurationDetails: null` **Note:** `SessionPersistenceConfigurationDetails` (application cookie stickiness) and `LBCookieSessionPersistenceConfigurationDetails` (LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cookie_name varchar2(32767),
  disable_fallback number,
  domain varchar2(32767),
  path varchar2(32767),
  max_age_in_seconds number,
  is_secure number,
  is_http_only number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t (
    cookie_name varchar2,
    disable_fallback number,
    domain varchar2,
    path varchar2,
    max_age_in_seconds number,
    is_secure number,
    is_http_only number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_backend_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_backend_t) NOT PERSISTABLE;

The configuration of a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets. **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration` (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_set_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  policy varchar2(32767),
  backends dbms_cloud_oci_load_balancer_backend_tbl,
  health_checker dbms_cloud_oci_load_balancer_health_checker_t,
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_t,
  session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
  lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_t (
    name varchar2,
    policy varchar2,
    backends dbms_cloud_oci_load_balancer_backend_tbl,
    health_checker dbms_cloud_oci_load_balancer_health_checker_t,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_t,
    session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
    lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The health check policy's configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_health_checker_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  protocol varchar2(32767),
  url_path varchar2(32767),
  port number,
  return_code number,
  retries number,
  timeout_in_millis number,
  interval_in_millis number,
  response_body_regex varchar2(32767),
  is_force_plain_text number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_checker_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_health_checker_details_t (
    protocol varchar2,
    url_path varchar2,
    port number,
    return_code number,
    retries number,
    timeout_in_millis number,
    interval_in_millis number,
    response_body_regex varchar2,
    is_force_plain_text number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The load balancer's SSL handling configuration details. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ssl_configuration_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  verify_depth number,
  verify_peer_certificate number,
  trusted_certificate_authority_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  certificate_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  certificate_name varchar2(32767),
  protocols dbms_cloud_oci_load_balancer_varchar2_tbl,
  cipher_suite_name varchar2(32767),
  server_order_preference varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_configuration_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_configuration_details_t (
    verify_depth number,
    verify_peer_certificate number,
    trusted_certificate_authority_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    certificate_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    certificate_name varchar2,
    protocols dbms_cloud_oci_load_balancer_varchar2_tbl,
    cipher_suite_name varchar2,
    server_order_preference varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_backend_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_backend_details_t) NOT PERSISTABLE;

The configuration details for a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets. **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration` (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  policy varchar2(32767),
  backends dbms_cloud_oci_load_balancer_backend_details_tbl,
  health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
  lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_details_t (
    policy varchar2,
    backends dbms_cloud_oci_load_balancer_backend_details_tbl,
    health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
    lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The health status details for a backend set. This object does not explicitly enumerate backend servers with a status of `OK`. However, they are included in the `totalBackendCount` sum.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_backend_set_health_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  warning_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  critical_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  unknown_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  total_backend_count number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_health_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_backend_set_health_t (
    status varchar2,
    warning_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    critical_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    unknown_state_backend_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    total_backend_count number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details of a certificate bundle. For more information on SSL certficate configuration, see Managing SSL Certificates. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_certificate_t FORCE AUTHID CURRENT_USER IS OBJECT (
  certificate_name varchar2(32767),
  public_certificate varchar2(32767),
  ca_certificate varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_certificate_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_certificate_t (
    certificate_name varchar2,
    public_certificate varchar2,
    ca_certificate varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for a certificate bundle. For more information on SSL certficate configuration, see Managing SSL Certificates. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  passphrase varchar2(32767),
  private_key varchar2(32767),
  public_certificate varchar2(32767),
  ca_certificate varchar2(32767),
  certificate_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_certificate_details_t (
    passphrase varchar2,
    private_key varchar2,
    public_certificate varchar2,
    ca_certificate varchar2,
    certificate_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for moving a load balancer to a different compartment. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_change_load_balancer_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_change_load_balancer_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_change_load_balancer_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configuration details for the connection between the client and backend servers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_connection_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  idle_timeout number,
  backend_tcp_proxy_protocol_version number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_connection_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_connection_configuration_t (
    idle_timeout number,
    backend_tcp_proxy_protocol_version number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object that represents the action of returning a specified response code when the requested HTTP method is not in the list of allowed methods for the listener. The load balancer does not forward a disallowed request to the back end servers. The default response code is `405 Method Not Allowed`. If you set the response code to `405` or leave it blank, the system adds an \"allow\" response header that contains a list of the allowed methods for the listener. If you set the response code to anything other than `405` (or blank), the system does not add the \"allow\" response header with a list of allowed methods. This rule applies only to HTTP listeners. No more than one `ControlAccessUsingHttpMethodsRule` object can be present in a given listener.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_control_access_using_http_methods_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  allowed_methods dbms_cloud_oci_load_balancer_varchar2_tbl,
  status_code number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_control_access_using_http_methods_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_control_access_using_http_methods_rule_t (
    action varchar2,
    allowed_methods dbms_cloud_oci_load_balancer_varchar2_tbl,
    status_code number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_control_access_using_http_methods_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_backend_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ip_address varchar2(32767),
  port number,
  weight number,
  backup number,
  drain number,
  l_offline number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_backend_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_backend_details_t (
    ip_address varchar2,
    port number,
    weight number,
    backup number,
    drain number,
    l_offline number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for creating a backend set in a load balancer. For more information on backend set configuration, see Managing Backend Sets. **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration` (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_backend_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  policy varchar2(32767),
  backends dbms_cloud_oci_load_balancer_backend_details_tbl,
  health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
  lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_backend_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_backend_set_details_t (
    name varchar2,
    policy varchar2,
    backends dbms_cloud_oci_load_balancer_backend_details_tbl,
    health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
    lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for adding a certificate bundle to a listener. For more information on SSL certficate configuration, see Managing SSL Certificates. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  passphrase varchar2(32767),
  private_key varchar2(32767),
  public_certificate varchar2(32767),
  ca_certificate varchar2(32767),
  certificate_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_certificate_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_certificate_details_t (
    passphrase varchar2,
    private_key varchar2,
    public_certificate varchar2,
    ca_certificate varchar2,
    certificate_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The details of the hostname resource to add to a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_hostname_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  hostname varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_hostname_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_hostname_details_t (
    name varchar2,
    hostname varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for adding a listener to a backend set. For more information on listener configuration, see Managing Load Balancer Listeners. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_listener_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  default_backend_set_name varchar2(32767),
  port number,
  protocol varchar2(32767),
  hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  path_route_set_name varchar2(32767),
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
  name varchar2(32767),
  routing_policy_name varchar2(32767),
  rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_listener_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_listener_details_t (
    default_backend_set_name varchar2,
    port number,
    protocol varchar2,
    hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    path_route_set_name varchar2,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
    name varchar2,
    routing_policy_name varchar2,
    rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details to update load balancer to a different shape.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_shape_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  minimum_bandwidth_in_mbps number,
  maximum_bandwidth_in_mbps number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_shape_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_shape_details_t (
    minimum_bandwidth_in_mbps number,
    maximum_bandwidth_in_mbps number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_reserved_ip_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_reserved_ip_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_reserved_ip_t (
    id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The listener's configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_listener_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  default_backend_set_name varchar2(32767),
  port number,
  protocol varchar2(32767),
  hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  path_route_set_name varchar2(32767),
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
  routing_policy_name varchar2(32767),
  rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_details_t (
    default_backend_set_name varchar2,
    port number,
    protocol varchar2,
    hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    path_route_set_name varchar2,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
    routing_policy_name varchar2,
    rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The details of a hostname resource associated with a load balancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_hostname_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  hostname varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_hostname_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_hostname_details_t (
    name varchar2,
    hostname varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration. You can create custom cipher suites if the predefined cipher suites do not meet your requirements. * __oci-default-ssl-cipher-suite-v1__ \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-modern-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" * __oci-wider-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"CAMELLIA128-SHA\" \"CAMELLIA256-SHA\" \"DES-CBC3-SHA\" \"DH-DSS-AES128-GCM-SHA256\" \"DH-DSS-AES128-SHA\" \"DH-DSS-AES128-SHA256\" \"DH-DSS-AES256-GCM-SHA384\" \"DH-DSS-AES256-SHA\" \"DH-DSS-AES256-SHA256\" \"DH-DSS-CAMELLIA128-SHA\" \"DH-DSS-CAMELLIA256-SHA\" \"DH-DSS-DES-CBC3-SHAv\" \"DH-DSS-SEED-SHA\" \"DH-RSA-AES128-GCM-SHA256\" \"DH-RSA-AES128-SHA\" \"DH-RSA-AES128-SHA256\" \"DH-RSA-AES256-GCM-SHA384\" \"DH-RSA-AES256-SHA\" \"DH-RSA-AES256-SHA256\" \"DH-RSA-CAMELLIA128-SHA\" \"DH-RSA-CAMELLIA256-SHA\" \"DH-RSA-DES-CBC3-SHA\" \"DH-RSA-SEED-SHA\" \"DHE-DSS-AES128-GCM-SHA256\" \"DHE-DSS-AES128-SHA\" \"DHE-DSS-AES128-SHA256\" \"DHE-DSS-AES256-GCM-SHA384\" \"DHE-DSS-AES256-SHA\" \"DHE-DSS-AES256-SHA256\" \"DHE-DSS-CAMELLIA128-SHA\" \"DHE-DSS-CAMELLIA256-SHA\" \"DHE-DSS-DES-CBC3-SHA\" \"DHE-DSS-SEED-SHA\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA\" \"DHE-RSA-AES256-SHA256\" \"DHE-RSA-CAMELLIA128-SHA\" \"DHE-RSA-CAMELLIA256-SHA\" \"DHE-RSA-DES-CBC3-SHA\" \"DHE-RSA-SEED-SHA\" \"ECDH-ECDSA-AES128-GCM-SHA256\" \"ECDH-ECDSA-AES128-SHA\" \"ECDH-ECDSA-AES128-SHA256\" \"ECDH-ECDSA-AES256-GCM-SHA384\" \"ECDH-ECDSA-AES256-SHA\" \"ECDH-ECDSA-AES256-SHA384\" \"ECDH-ECDSA-DES-CBC3-SHA\" \"ECDH-ECDSA-RC4-SHA\" \"ECDH-RSA-AES128-GCM-SHA256\" \"ECDH-RSA-AES128-SHA\" \"ECDH-RSA-AES128-SHA256\" \"ECDH-RSA-AES256-GCM-SHA384\" \"ECDH-RSA-AES256-SHA\" \"ECDH-RSA-AES256-SHA384\" \"ECDH-RSA-DES-CBC3-SHA\" \"ECDH-RSA-RC4-SHA\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-ECDSA-DES-CBC3-SHA\" \"ECDHE-ECDSA-RC4-SHA\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" \"ECDHE-RSA-DES-CBC3-SHA\" \"ECDHE-RSA-RC4-SHA\" \"IDEA-CBC-SHA\" \"KRB5-DES-CBC3-MD5\" \"KRB5-DES-CBC3-SHA\" \"KRB5-IDEA-CBC-MD5\" \"KRB5-IDEA-CBC-SHA\" \"KRB5-RC4-MD5\" \"KRB5-RC4-SHA\" \"PSK-3DES-EDE-CBC-SHA\" \"PSK-AES128-CBC-SHA\" \"PSK-AES256-CBC-SHA\" \"PSK-RC4-SHA\" \"RC4-MD5\" \"RC4-SHA\" \"SEED-SHA\"

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ssl_cipher_suite_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  ciphers dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_cipher_suite_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_cipher_suite_details_t (
    name varchar2,
    ciphers dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The type of matching to apply to incoming URIs.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_match_type_t FORCE AUTHID CURRENT_USER IS OBJECT (
  match_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_match_type_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_match_type_t (
    match_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A \"path route rule\" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_route_t FORCE AUTHID CURRENT_USER IS OBJECT (
  path varchar2(32767),
  path_match_type dbms_cloud_oci_load_balancer_path_match_type_t,
  backend_set_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_t (
    path varchar2,
    path_match_type dbms_cloud_oci_load_balancer_path_match_type_t,
    backend_set_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_path_route_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_route_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_path_route_t) NOT PERSISTABLE;

A set of path route rules.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_route_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  path_routes dbms_cloud_oci_load_balancer_path_route_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_set_details_t (
    path_routes dbms_cloud_oci_load_balancer_path_route_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_rule_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_rule_t) NOT PERSISTABLE;

The rules that compose a rule set.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_load_balancer_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_set_details_t (
    items dbms_cloud_oci_load_balancer_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_reserved_ip_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_reserved_ip_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_reserved_ip_t) NOT PERSISTABLE;

The configuration details for creating a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_load_balancer_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  shape_name varchar2(32767),
  shape_details dbms_cloud_oci_load_balancer_shape_details_t,
  is_private number,
  ip_mode varchar2(32767),
  reserved_ips dbms_cloud_oci_load_balancer_reserved_ip_tbl,
  listeners json_element_t,
  hostnames json_element_t,
  backend_sets json_element_t,
  network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  subnet_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  certificates json_element_t,
  ssl_cipher_suites json_element_t,
  path_route_sets json_element_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  rule_sets json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_load_balancer_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_load_balancer_details_t (
    compartment_id varchar2,
    display_name varchar2,
    shape_name varchar2,
    shape_details dbms_cloud_oci_load_balancer_shape_details_t,
    is_private number,
    ip_mode varchar2,
    reserved_ips dbms_cloud_oci_load_balancer_reserved_ip_tbl,
    listeners json_element_t,
    hostnames json_element_t,
    backend_sets json_element_t,
    network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    subnet_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    certificates json_element_t,
    ssl_cipher_suites json_element_t,
    path_route_sets json_element_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    rule_sets json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A named set of path route rules to add to the load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_path_route_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  path_routes dbms_cloud_oci_load_balancer_path_route_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_path_route_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_path_route_set_details_t (
    name varchar2,
    path_routes dbms_cloud_oci_load_balancer_path_route_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_action_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_action_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_action_t) NOT PERSISTABLE;

A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_routing_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  condition varchar2(32767),
  actions dbms_cloud_oci_load_balancer_action_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_rule_t (
    name varchar2,
    condition varchar2,
    actions dbms_cloud_oci_load_balancer_action_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_routing_rule_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_routing_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_routing_rule_t) NOT PERSISTABLE;

An ordered list of routing rules. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_routing_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  condition_language_version varchar2(32767),
  rules dbms_cloud_oci_load_balancer_routing_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_routing_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_routing_policy_details_t (
    name varchar2,
    condition_language_version varchar2,
    rules dbms_cloud_oci_load_balancer_routing_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A named set of rules to add to the load balancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_rule_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  items dbms_cloud_oci_load_balancer_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_rule_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_rule_set_details_t (
    name varchar2,
    items dbms_cloud_oci_load_balancer_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration. You can create custom cipher suites if the predefined cipher suites do not meet your requirements. * __oci-default-ssl-cipher-suite-v1__ \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-modern-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" * __oci-wider-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"CAMELLIA128-SHA\" \"CAMELLIA256-SHA\" \"DES-CBC3-SHA\" \"DH-DSS-AES128-GCM-SHA256\" \"DH-DSS-AES128-SHA\" \"DH-DSS-AES128-SHA256\" \"DH-DSS-AES256-GCM-SHA384\" \"DH-DSS-AES256-SHA\" \"DH-DSS-AES256-SHA256\" \"DH-DSS-CAMELLIA128-SHA\" \"DH-DSS-CAMELLIA256-SHA\" \"DH-DSS-DES-CBC3-SHAv\" \"DH-DSS-SEED-SHA\" \"DH-RSA-AES128-GCM-SHA256\" \"DH-RSA-AES128-SHA\" \"DH-RSA-AES128-SHA256\" \"DH-RSA-AES256-GCM-SHA384\" \"DH-RSA-AES256-SHA\" \"DH-RSA-AES256-SHA256\" \"DH-RSA-CAMELLIA128-SHA\" \"DH-RSA-CAMELLIA256-SHA\" \"DH-RSA-DES-CBC3-SHA\" \"DH-RSA-SEED-SHA\" \"DHE-DSS-AES128-GCM-SHA256\" \"DHE-DSS-AES128-SHA\" \"DHE-DSS-AES128-SHA256\" \"DHE-DSS-AES256-GCM-SHA384\" \"DHE-DSS-AES256-SHA\" \"DHE-DSS-AES256-SHA256\" \"DHE-DSS-CAMELLIA128-SHA\" \"DHE-DSS-CAMELLIA256-SHA\" \"DHE-DSS-DES-CBC3-SHA\" \"DHE-DSS-SEED-SHA\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA\" \"DHE-RSA-AES256-SHA256\" \"DHE-RSA-CAMELLIA128-SHA\" \"DHE-RSA-CAMELLIA256-SHA\" \"DHE-RSA-DES-CBC3-SHA\" \"DHE-RSA-SEED-SHA\" \"ECDH-ECDSA-AES128-GCM-SHA256\" \"ECDH-ECDSA-AES128-SHA\" \"ECDH-ECDSA-AES128-SHA256\" \"ECDH-ECDSA-AES256-GCM-SHA384\" \"ECDH-ECDSA-AES256-SHA\" \"ECDH-ECDSA-AES256-SHA384\" \"ECDH-ECDSA-DES-CBC3-SHA\" \"ECDH-ECDSA-RC4-SHA\" \"ECDH-RSA-AES128-GCM-SHA256\" \"ECDH-RSA-AES128-SHA\" \"ECDH-RSA-AES128-SHA256\" \"ECDH-RSA-AES256-GCM-SHA384\" \"ECDH-RSA-AES256-SHA\" \"ECDH-RSA-AES256-SHA384\" \"ECDH-RSA-DES-CBC3-SHA\" \"ECDH-RSA-RC4-SHA\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-ECDSA-DES-CBC3-SHA\" \"ECDHE-ECDSA-RC4-SHA\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" \"ECDHE-RSA-DES-CBC3-SHA\" \"ECDHE-RSA-RC4-SHA\" \"IDEA-CBC-SHA\" \"KRB5-DES-CBC3-MD5\" \"KRB5-DES-CBC3-SHA\" \"KRB5-IDEA-CBC-MD5\" \"KRB5-IDEA-CBC-SHA\" \"KRB5-RC4-MD5\" \"KRB5-RC4-SHA\" \"PSK-3DES-EDE-CBC-SHA\" \"PSK-AES128-CBC-SHA\" \"PSK-AES256-CBC-SHA\" \"PSK-RC4-SHA\" \"RC4-MD5\" \"RC4-SHA\" \"SEED-SHA\"

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_create_ssl_cipher_suite_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  ciphers dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_ssl_cipher_suite_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_create_ssl_cipher_suite_details_t (
    name varchar2,
    ciphers dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object that represents the action of modifying a request header value. This rule applies only to HTTP listeners. This rule adds a prefix, a suffix, or both to the header value. **NOTES:** * This rule requires a value for a prefix, suffix, or both. * The system does not support this rule for headers with multiple values. * The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_extend_http_request_header_value_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  prefix varchar2(32767),
  suffix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_extend_http_request_header_value_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_extend_http_request_header_value_rule_t (
    action varchar2,
    header varchar2,
    prefix varchar2,
    suffix varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_extend_http_request_header_value_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

An object that represents the action of modifying a response header value. This rule applies only to HTTP listeners. This rule adds a prefix, a suffix, or both to the header value. **NOTES:** * This rule requires a value for a prefix, suffix, or both. * The system does not support this rule for headers with multiple values. * The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_extend_http_response_header_value_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  prefix varchar2(32767),
  suffix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_extend_http_response_header_value_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_extend_http_response_header_value_rule_t (
    action varchar2,
    header varchar2,
    prefix varchar2,
    suffix varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_extend_http_response_header_value_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

Action to forward requests to a given backend set.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_forward_to_backend_set_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_action_t (
  backend_set_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_forward_to_backend_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_forward_to_backend_set_t (
    name varchar2,
    backend_set_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_forward_to_backend_set_t is a subtype of the dbms_cloud_oci_load_balancer_action_t type.

Fields

A hostname resource associated with a load balancer for use by one or more listeners. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_hostname_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  hostname varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_hostname_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_hostname_t (
    name varchar2,
    hostname varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object that represents the advance http header options that allow the setting of http header size and allow/disallow invalid characters in the http headers. For example httpLargeHeaderSizeInKB=32, the http header could have 4 buffers of 32KBs each This rule applies only to HTTP listeners. No more than one `HttpHeaderRule` object can be present in a given listener.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_http_header_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  are_invalid_characters_allowed number,
  http_large_header_size_in_kb number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_http_header_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_http_header_rule_t (
    action varchar2,
    are_invalid_characters_allowed number,
    http_large_header_size_in_kb number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_http_header_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

A load balancer IP address.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ip_address_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ip_address varchar2(32767),
  is_public number,
  reserved_ip dbms_cloud_oci_load_balancer_reserved_ip_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ip_address_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ip_address_t (
    ip_address varchar2,
    is_public number,
    reserved_ip dbms_cloud_oci_load_balancer_reserved_ip_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The listener's configuration. For more information on backend set configuration, see Managing Load Balancer Listeners.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_listener_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  default_backend_set_name varchar2(32767),
  port number,
  protocol varchar2(32767),
  hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  path_route_set_name varchar2(32767),
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_t,
  connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
  rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  routing_policy_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_t (
    name varchar2,
    default_backend_set_name varchar2,
    port number,
    protocol varchar2,
    hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    path_route_set_name varchar2,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_t,
    connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
    rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    routing_policy_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_listener_rule_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  rule dbms_cloud_oci_load_balancer_rule_t,
  rule_set_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_rule_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_listener_rule_summary_t (
    rule dbms_cloud_oci_load_balancer_rule_t,
    rule_set_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket Layer (SSL) network connections. A cipher suite defines the list of security algorithms your load balancer uses to negotiate with peers while sending and receiving information. The cipher suites you use affect the security level, performance, and compatibility of your data traffic. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. Oracle created the following predefined cipher suites that you can specify when you define a resource's SSL configuration. You can create custom cipher suites if the predefined cipher suites do not meet your requirements. * __oci-default-ssl-cipher-suite-v1__ \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-modern-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA384\" * __oci-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA256\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" * __oci-wider-compatible-ssl-cipher-suite-v1__ \"AES128-GCM-SHA256\" \"AES128-SHA\" \"AES128-SHA256\" \"AES256-GCM-SHA384\" \"AES256-SHA\" \"AES256-SHA256\" \"CAMELLIA128-SHA\" \"CAMELLIA256-SHA\" \"DES-CBC3-SHA\" \"DH-DSS-AES128-GCM-SHA256\" \"DH-DSS-AES128-SHA\" \"DH-DSS-AES128-SHA256\" \"DH-DSS-AES256-GCM-SHA384\" \"DH-DSS-AES256-SHA\" \"DH-DSS-AES256-SHA256\" \"DH-DSS-CAMELLIA128-SHA\" \"DH-DSS-CAMELLIA256-SHA\" \"DH-DSS-DES-CBC3-SHAv\" \"DH-DSS-SEED-SHA\" \"DH-RSA-AES128-GCM-SHA256\" \"DH-RSA-AES128-SHA\" \"DH-RSA-AES128-SHA256\" \"DH-RSA-AES256-GCM-SHA384\" \"DH-RSA-AES256-SHA\" \"DH-RSA-AES256-SHA256\" \"DH-RSA-CAMELLIA128-SHA\" \"DH-RSA-CAMELLIA256-SHA\" \"DH-RSA-DES-CBC3-SHA\" \"DH-RSA-SEED-SHA\" \"DHE-DSS-AES128-GCM-SHA256\" \"DHE-DSS-AES128-SHA\" \"DHE-DSS-AES128-SHA256\" \"DHE-DSS-AES256-GCM-SHA384\" \"DHE-DSS-AES256-SHA\" \"DHE-DSS-AES256-SHA256\" \"DHE-DSS-CAMELLIA128-SHA\" \"DHE-DSS-CAMELLIA256-SHA\" \"DHE-DSS-DES-CBC3-SHA\" \"DHE-DSS-SEED-SHA\" \"DHE-RSA-AES128-GCM-SHA256\" \"DHE-RSA-AES128-SHA\" \"DHE-RSA-AES128-SHA256\" \"DHE-RSA-AES256-GCM-SHA384\" \"DHE-RSA-AES256-SHA\" \"DHE-RSA-AES256-SHA256\" \"DHE-RSA-CAMELLIA128-SHA\" \"DHE-RSA-CAMELLIA256-SHA\" \"DHE-RSA-DES-CBC3-SHA\" \"DHE-RSA-SEED-SHA\" \"ECDH-ECDSA-AES128-GCM-SHA256\" \"ECDH-ECDSA-AES128-SHA\" \"ECDH-ECDSA-AES128-SHA256\" \"ECDH-ECDSA-AES256-GCM-SHA384\" \"ECDH-ECDSA-AES256-SHA\" \"ECDH-ECDSA-AES256-SHA384\" \"ECDH-ECDSA-DES-CBC3-SHA\" \"ECDH-ECDSA-RC4-SHA\" \"ECDH-RSA-AES128-GCM-SHA256\" \"ECDH-RSA-AES128-SHA\" \"ECDH-RSA-AES128-SHA256\" \"ECDH-RSA-AES256-GCM-SHA384\" \"ECDH-RSA-AES256-SHA\" \"ECDH-RSA-AES256-SHA384\" \"ECDH-RSA-DES-CBC3-SHA\" \"ECDH-RSA-RC4-SHA\" \"ECDHE-ECDSA-AES128-GCM-SHA256\" \"ECDHE-ECDSA-AES128-SHA\" \"ECDHE-ECDSA-AES128-SHA256\" \"ECDHE-ECDSA-AES256-GCM-SHA384\" \"ECDHE-ECDSA-AES256-SHA\" \"ECDHE-ECDSA-AES256-SHA384\" \"ECDHE-ECDSA-DES-CBC3-SHA\" \"ECDHE-ECDSA-RC4-SHA\" \"ECDHE-RSA-AES128-GCM-SHA256\" \"ECDHE-RSA-AES128-SHA\" \"ECDHE-RSA-AES128-SHA256\" \"ECDHE-RSA-AES256-GCM-SHA384\" \"ECDHE-RSA-AES256-SHA\" \"ECDHE-RSA-AES256-SHA384\" \"ECDHE-RSA-DES-CBC3-SHA\" \"ECDHE-RSA-RC4-SHA\" \"IDEA-CBC-SHA\" \"KRB5-DES-CBC3-MD5\" \"KRB5-DES-CBC3-SHA\" \"KRB5-IDEA-CBC-MD5\" \"KRB5-IDEA-CBC-SHA\" \"KRB5-RC4-MD5\" \"KRB5-RC4-SHA\" \"PSK-3DES-EDE-CBC-SHA\" \"PSK-AES128-CBC-SHA\" \"PSK-AES256-CBC-SHA\" \"PSK-RC4-SHA\" \"RC4-MD5\" \"RC4-SHA\" \"SEED-SHA\"

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ssl_cipher_suite_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  ciphers dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_cipher_suite_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_ssl_cipher_suite_t (
    name varchar2,
    ciphers dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A named set of path route rules. For more information, see Managing Request Routing. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_route_set_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  path_routes dbms_cloud_oci_load_balancer_path_route_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_route_set_t (
    name varchar2,
    path_routes dbms_cloud_oci_load_balancer_path_route_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, such as adding, altering, or removing HTTP headers. For more information, see Managing Rule Sets.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_rule_set_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  items dbms_cloud_oci_load_balancer_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_set_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_rule_set_t (
    name varchar2,
    items dbms_cloud_oci_load_balancer_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A named ordered list of routing rules that is applied to a listener. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_routing_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  condition_language_version varchar2(32767),
  rules dbms_cloud_oci_load_balancer_routing_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_policy_t (
    name varchar2,
    condition_language_version varchar2,
    rules dbms_cloud_oci_load_balancer_routing_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_ip_address_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_ip_address_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_ip_address_t) NOT PERSISTABLE;

The properties that define a load balancer. For more information, see Managing a Load Balancer. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  lifecycle_state varchar2(32767),
  time_created timestamp with time zone,
  ip_addresses dbms_cloud_oci_load_balancer_ip_address_tbl,
  shape_name varchar2(32767),
  shape_details dbms_cloud_oci_load_balancer_shape_details_t,
  is_private number,
  subnet_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  listeners json_element_t,
  hostnames json_element_t,
  ssl_cipher_suites json_element_t,
  certificates json_element_t,
  backend_sets json_element_t,
  path_route_sets json_element_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  rule_sets json_element_t,
  routing_policies json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    lifecycle_state varchar2,
    time_created timestamp with time zone,
    ip_addresses dbms_cloud_oci_load_balancer_ip_address_tbl,
    shape_name varchar2,
    shape_details dbms_cloud_oci_load_balancer_shape_details_t,
    is_private number,
    subnet_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
    listeners json_element_t,
    hostnames json_element_t,
    ssl_cipher_suites json_element_t,
    certificates json_element_t,
    backend_sets json_element_t,
    path_route_sets json_element_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    rule_sets json_element_t,
    routing_policies json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The health status details for the specified load balancer. This object does not explicitly enumerate backend sets with a status of `OK`. However, they are included in the `totalBackendSetCount` sum.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_health_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  warning_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  critical_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  unknown_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  total_backend_set_count number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_health_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_health_t (
    status varchar2,
    warning_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    critical_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    unknown_state_backend_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    total_backend_set_count number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A health status summary for the specified load balancer.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_health_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  load_balancer_id varchar2(32767),
  status varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_health_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_health_summary_t (
    load_balancer_id varchar2,
    status varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A policy that determines how traffic is distributed among backend servers. For more information on load balancing policies, see How Load Balancing Policies Work.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_policy_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_policy_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A protocol that defines the type of traffic accepted by a listener.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_protocol_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_protocol_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_protocol_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the load balancer. Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client attempting to use the full bandwidth.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_load_balancer_shape_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_shape_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_load_balancer_shape_t (
    name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The path string and match condition to apply when evaluating an incoming URI for redirection.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_path_match_condition_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_condition_t (
  attribute_value varchar2(32767),
  operator varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_match_condition_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_path_match_condition_t (
    attribute_name varchar2,
    attribute_value varchar2,
    operator varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_path_match_condition_t is a subtype of the dbms_cloud_oci_load_balancer_rule_condition_t type.

Fields

An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI. **NOTE:** The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide meaningful, complete, and correct field values. If any component field of this object has no value, the system retains the value from the incoming HTTP request URI. For example, if you specify only the protocol field `https`, and the incoming request URI is `http://example.com:8080`, the resulting runtime redirect URI is `https://example.com:8080`. The system retains the host and port from the incoming URI and does not automatically change the port setting from `8080` to `443`. Be sure to configure valid percent-encoding (URL encoding) when needed. In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens extract values from the incoming HTTP request URI. * {protocol} : The protocol from the incoming HTTP request URI. * {host} : The domain name from the incoming HTTP request URI. * {port} : The port from the incoming HTTP request URI. * {path} : The path from the incoming HTTP request URI. * {query} : The query string from the incoming HTTP request URI. The tokens are case sensitive. For example, `{host}` is a valid token, but `{HOST}` is not. You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\\\) as the escape character for the \\\\, {, and } characters. For example, if the incoming HTTP request URI is `/video`, the path property value: `/example{path}123\\{path\\}` appears in the constructed redirect URI as: `/example/video123{path}`

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_redirect_uri_t FORCE AUTHID CURRENT_USER IS OBJECT (
  protocol varchar2(32767),
  host varchar2(32767),
  port number,
  path varchar2(32767),
  query varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_redirect_uri_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_redirect_uri_t (
    protocol varchar2,
    host varchar2,
    port number,
    path varchar2,
    query varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object that represents the action of returning a specified response code and a redirect URI. Each RedirectRule object is configured for a particular listener and a designated path. The default response code is `302 Found`. **NOTES:** * This rule applies only to HTTP listeners. * You can specify this rule only with the RULE_CONDITION Function type `PATH`. * A listener can have only one RedirectRule object for a given original path. The PATH_MATCH_CONDITION Function `attributeValue` specifies the original path.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_redirect_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  response_code number,
  conditions dbms_cloud_oci_load_balancer_rule_condition_tbl,
  redirect_uri dbms_cloud_oci_load_balancer_redirect_uri_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_redirect_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_redirect_rule_t (
    action varchar2,
    response_code number,
    conditions dbms_cloud_oci_load_balancer_rule_condition_tbl,
    redirect_uri dbms_cloud_oci_load_balancer_redirect_uri_t
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_redirect_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

An object that represents the action of removing a header from a request. This rule applies only to HTTP listeners. If the same header appears more than once in the request, the load balancer removes all occurances of the specified header. **Note:** The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_remove_http_request_header_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_remove_http_request_header_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_remove_http_request_header_rule_t (
    action varchar2,
    header varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_remove_http_request_header_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

An object that represents the action of removing a header from a response. This rule applies only to HTTP listeners. If the same header appears more than once in the response, the load balancer removes all occurances of the specified header. **Note:** The system does not distinquish between underscore and dash characters in headers. That is, it treats `example_header_name` and `example-header-name` as identical. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_remove_http_response_header_rule_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_t (
  header varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_remove_http_response_header_rule_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_remove_http_response_header_rule_t (
    action varchar2,
    header varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_remove_http_response_header_rule_t is a subtype of the dbms_cloud_oci_load_balancer_rule_t type.

Fields

An ordered list of routing rules. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_routing_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  rules dbms_cloud_oci_load_balancer_routing_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_routing_policy_details_t (
    rules dbms_cloud_oci_load_balancer_routing_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

A rule condition that checks client source IP against specified IP address or address range.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_source_ip_address_condition_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_condition_t (
  attribute_value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_ip_address_condition_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_ip_address_condition_t (
    attribute_name varchar2,
    attribute_value varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_source_ip_address_condition_t is a subtype of the dbms_cloud_oci_load_balancer_rule_condition_t type.

Fields

An access control rule condition that requires a match on the specified source VCN OCID.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_source_vcn_id_condition_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_condition_t (
  attribute_value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_vcn_id_condition_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_vcn_id_condition_t (
    attribute_name varchar2,
    attribute_value varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_source_vcn_id_condition_t is a subtype of the dbms_cloud_oci_load_balancer_rule_condition_t type.

Fields

An access control rule condition that requires a match on the specified source VCN and IP address range. This condition must be used only in conjunction with `SourceVcnIdCondition`.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_source_vcn_ip_address_condition_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_load_balancer_rule_condition_t (
  attribute_value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_vcn_ip_address_condition_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_source_vcn_ip_address_condition_t (
    attribute_name varchar2,
    attribute_value varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_load_balancer_source_vcn_ip_address_condition_t is a subtype of the dbms_cloud_oci_load_balancer_rule_condition_t type.

Fields

The configuration details for updating a backend server.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_backend_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  weight number,
  backup number,
  drain number,
  l_offline number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_backend_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_backend_details_t (
    weight number,
    backup number,
    drain number,
    l_offline number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for updating a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets. **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration` (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_backend_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  policy varchar2(32767),
  backends dbms_cloud_oci_load_balancer_backend_details_tbl,
  health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
  lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_backend_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_backend_set_details_t (
    policy varchar2,
    backends dbms_cloud_oci_load_balancer_backend_details_tbl,
    health_checker dbms_cloud_oci_load_balancer_health_checker_details_t,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    session_persistence_configuration dbms_cloud_oci_load_balancer_session_persistence_configuration_details_t,
    lb_cookie_session_persistence_configuration dbms_cloud_oci_load_balancer_lb_cookie_session_persistence_configuration_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The health checker's configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_health_checker_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  protocol varchar2(32767),
  url_path varchar2(32767),
  port number,
  return_code number,
  retries number,
  timeout_in_millis number,
  interval_in_millis number,
  response_body_regex varchar2(32767),
  is_force_plain_text number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_health_checker_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_health_checker_details_t (
    protocol varchar2,
    url_path varchar2,
    port number,
    return_code number,
    retries number,
    timeout_in_millis number,
    interval_in_millis number,
    response_body_regex varchar2,
    is_force_plain_text number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for updating a virtual hostname. For more information on virtual hostnames, see Managing Request Routing.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_hostname_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  hostname varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_hostname_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_hostname_details_t (
    hostname varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for updating a listener.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_listener_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  default_backend_set_name varchar2(32767),
  port number,
  protocol varchar2(32767),
  hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  path_route_set_name varchar2(32767),
  routing_policy_name varchar2(32767),
  ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
  connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
  rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_listener_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_listener_details_t (
    default_backend_set_name varchar2,
    port number,
    protocol varchar2,
    hostname_names dbms_cloud_oci_load_balancer_varchar2_tbl,
    path_route_set_name varchar2,
    routing_policy_name varchar2,
    ssl_configuration dbms_cloud_oci_load_balancer_ssl_configuration_details_t,
    connection_configuration dbms_cloud_oci_load_balancer_connection_configuration_t,
    rule_set_names dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Configuration details to update a load balancer. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_load_balancer_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_load_balancer_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_load_balancer_details_t (
    display_name varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_load_balancer_shape_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  shape_name varchar2(32767),
  shape_details dbms_cloud_oci_load_balancer_shape_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_load_balancer_shape_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_load_balancer_shape_details_t (
    shape_name varchar2,
    shape_details dbms_cloud_oci_load_balancer_shape_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs. * If the load balancer has no NSGs configured, it uses the NSGs in this list. * If the load balancer has a list of NSGs configured, this list replaces the existing list. * If the load balancer has a list of NSGs configured and this list is empty, the operation removes all of the load balancer's NSG associations.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_network_security_groups_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_network_security_groups_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_network_security_groups_details_t (
    network_security_group_ids dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An updated set of path route rules that overwrites the existing set of rules.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_path_route_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  path_routes dbms_cloud_oci_load_balancer_path_route_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_path_route_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_path_route_set_details_t (
    path_routes dbms_cloud_oci_load_balancer_path_route_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An updated list of routing rules that overwrites the existing list of routing rules.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_routing_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  condition_language_version varchar2(32767),
  rules dbms_cloud_oci_load_balancer_routing_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_routing_policy_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_routing_policy_details_t (
    condition_language_version varchar2,
    rules dbms_cloud_oci_load_balancer_routing_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An updated set of rules that overwrites the existing set of rules.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_rule_set_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_load_balancer_rule_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_rule_set_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_rule_set_details_t (
    items dbms_cloud_oci_load_balancer_rule_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

The configuration details for updating an SSL cipher suite. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_update_ssl_cipher_suite_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ciphers dbms_cloud_oci_load_balancer_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_ssl_cipher_suite_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_update_ssl_cipher_suite_details_t (
    ciphers dbms_cloud_oci_load_balancer_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

An object returned in the event of a work request error.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  error_code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_work_request_error_t (
    error_code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Nested table type of dbms_cloud_oci_load_balancer_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_load_balancer_work_request_error_t) NOT PERSISTABLE;

Many of the API requests you use to create and configure load balancing do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_load_balancer_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  load_balancer_id varchar2(32767),
  l_type varchar2(32767),
  compartment_id varchar2(32767),
  lifecycle_state varchar2(32767),
  message varchar2(32767),
  time_accepted timestamp with time zone,
  time_finished timestamp with time zone,
  error_details dbms_cloud_oci_load_balancer_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_load_balancer_work_request_t (
    id varchar2,
    load_balancer_id varchar2,
    l_type varchar2,
    compartment_id varchar2,
    lifecycle_state varchar2,
    message varchar2,
    time_accepted timestamp with time zone,
    time_finished timestamp with time zone,
    error_details dbms_cloud_oci_load_balancer_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields