WAAS Common Types
DBMS_CLOUD_OCI_WAAS_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_ACCESS_RULE_CRITERIA_T Type
When defined, the parent challenge would be applied only for the requests that matched all the listed conditions.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_access_rule_criteria_t FORCE AUTHID CURRENT_USER IS OBJECT (
condition varchar2(32767),
value varchar2(32767),
is_case_sensitive number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_access_rule_criteria_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_access_rule_criteria_t (
condition varchar2,
value varchar2,
is_case_sensitive number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. - **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. - **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). - **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). - **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. - **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. - **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \*Example:* \"1.1.1.1\1.1.1.2\1.2.2.1/30\" - **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \*Example:* \"1.1.1.1\1.1.1.2\1.2.2.1/30\" - **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. - **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. - **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` *Example:* \"GET\POST\" - **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the `value` field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` *Example:* \"GET\POST\" - **COUNTRY_IS:** Matches if the request originates from one of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website. *Example:* \"AL\DZ\AM\" - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website. *Example:* \"AL\DZ\AM\" - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` Allowed values are: 'URL_IS', 'URL_IS_NOT', 'URL_STARTS_WITH', 'URL_PART_ENDS_WITH', 'URL_PART_CONTAINS', 'URL_REGEX', 'URL_DOES_NOT_MATCH_REGEX', 'URL_DOES_NOT_START_WITH', 'URL_PART_DOES_NOT_CONTAIN', 'URL_PART_DOES_NOT_END_WITH', 'IP_IS', 'IP_IS_NOT', 'IP_IN_LIST', 'IP_NOT_IN_LIST', 'HTTP_HEADER_CONTAINS', 'HTTP_METHOD_IS', 'HTTP_METHOD_IS_NOT', 'COUNTRY_IS', 'COUNTRY_IS_NOT', 'USER_AGENT_IS', 'USER_AGENT_IS_NOT' |
|
|
(required) The criteria value. |
|
|
(optional) When enabled, the condition will be matched with case-sensitive rules. |
DBMS_CLOUD_OCI_WAAS_HEADER_MANIPULATION_ACTION_T Type
An object that represents an action to apply to an HTTP headers.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_header_manipulation_action_t FORCE AUTHID CURRENT_USER IS OBJECT (
action varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_header_manipulation_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_header_manipulation_action_t (
action varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) Allowed values are: 'EXTEND_HTTP_RESPONSE_HEADER', 'ADD_HTTP_RESPONSE_HEADER', 'REMOVE_HTTP_RESPONSE_HEADER' |
DBMS_CLOUD_OCI_WAAS_ACCESS_RULE_CRITERIA_TBL Type
Nested table type of dbms_cloud_oci_waas_access_rule_criteria_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_access_rule_criteria_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_access_rule_criteria_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_HEADER_MANIPULATION_ACTION_TBL Type
Nested table type of dbms_cloud_oci_waas_header_manipulation_action_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_header_manipulation_action_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_header_manipulation_action_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_ACCESS_RULE_T Type
A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_access_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
criteria dbms_cloud_oci_waas_access_rule_criteria_tbl,
action varchar2(32767),
block_action varchar2(32767),
block_response_code number,
block_error_page_message varchar2(32767),
block_error_page_code varchar2(32767),
block_error_page_description varchar2(32767),
bypass_challenges dbms_cloud_oci_waas_varchar2_tbl,
redirect_url varchar2(32767),
redirect_response_code varchar2(32767),
captcha_title varchar2(32767),
captcha_header varchar2(32767),
captcha_footer varchar2(32767),
captcha_submit_label varchar2(32767),
response_header_manipulation dbms_cloud_oci_waas_header_manipulation_action_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_access_rule_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_access_rule_t (
name varchar2,
criteria dbms_cloud_oci_waas_access_rule_criteria_tbl,
action varchar2,
block_action varchar2,
block_response_code number,
block_error_page_message varchar2,
block_error_page_code varchar2,
block_error_page_description varchar2,
bypass_challenges dbms_cloud_oci_waas_varchar2_tbl,
redirect_url varchar2,
redirect_response_code varchar2,
captcha_title varchar2,
captcha_header varchar2,
captcha_footer varchar2,
captcha_submit_label varchar2,
response_header_manipulation dbms_cloud_oci_waas_header_manipulation_action_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique name of the access rule. |
|
|
(required) The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions. |
|
|
(required) The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`. - **ALLOW:** Takes no action, just logs the request. - **DETECT:** Takes no action, but creates an alert for the request. - **BLOCK:** Blocks the request by returning specified response code or showing error page. - **BYPASS:** Bypasses some or all challenges. - **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`. - **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page. Regardless of action, no further rules are processed once a rule is matched. Allowed values are: 'ALLOW', 'DETECT', 'BLOCK', 'BYPASS', 'REDIRECT', 'SHOW_CAPTCHA' |
|
|
(optional) The method used to block requests if `action` is set to `BLOCK` and the access criteria are met. If unspecified, defaults to `SET_RESPONSE_CODE`. Allowed values are: 'SET_RESPONSE_CODE', 'SHOW_ERROR_PAGE' |
|
|
(optional) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. |
|
|
(optional) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.' |
|
|
(optional) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access rules'. |
|
|
(optional) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.' |
|
|
(optional) The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. - **JS_CHALLENGE:** Bypasses JavaScript Challenge. - **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. - **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. - **CAPTCHA:** Bypasses CAPTCHA Challenge. Allowed values are: 'JS_CHALLENGE', 'DEVICE_FINGERPRINT_CHALLENGE', 'HUMAN_INTERACTION_CHALLENGE', 'CAPTCHA' |
|
|
(optional) The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. |
|
|
(optional) The response status code to return when `action` is set to `REDIRECT`. - **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). - **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). Allowed values are: 'MOVED_PERMANENTLY', 'FOUND' |
|
|
(optional) The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. |
|
|
(optional) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. |
|
|
(optional) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. |
|
|
(optional) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `SHOW_CAPTCHA` and the request is challenged. |
|
|
(optional) An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. |
DBMS_CLOUD_OCI_WAAS_ADD_HTTP_RESPONSE_HEADER_ACTION_T Type
An object that represents the action of replacing or adding a header field. All prior occurrences of the header with the given name are removed and then the header field with specified value is added.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_add_http_response_header_action_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_header_manipulation_action_t (
header varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_add_http_response_header_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_add_http_response_header_action_t (
action varchar2,
header varchar2,
value varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_add_http_response_header_action_t is a subtype of the dbms_cloud_oci_waas_header_manipulation_action_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) A header field name that conforms to RFC 7230. Example: `example_header_name` |
|
|
(required) A header field value that conforms to RFC 7230. Example: `example_value` |
DBMS_CLOUD_OCI_WAAS_ADDRESS_LIST_T Type
The details of the address list.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_address_list_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
address_count number,
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_list_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_list_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
address_count number,
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2,
time_created timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the address list. |
|
|
(optional) The OCID of the address list's compartment. |
|
|
(optional) The user-friendly name of the address list. |
|
|
(optional) The total number of unique IP addresses in the address list. |
|
|
(optional) The list of IP addresses or CIDR notations. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(optional) The current lifecycle state of the address list. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the address list was created, expressed in RFC 3339 timestamp format. |
DBMS_CLOUD_OCI_WAAS_ADDRESS_LIST_SUMMARY_T Type
A summary of the address list's information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_address_list_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
address_count number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_list_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_list_summary_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
address_count number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2,
time_created timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the address list. |
|
|
(optional) The OCID of the address list's compartment. |
|
|
(optional) The user-friendly name of the address list. |
|
|
(optional) The total number of unique IP addresses in the address list. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(optional) The current lifecycle state of the address list. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the address list was created, in the format defined by RFC3339. |
DBMS_CLOUD_OCI_WAAS_ADDRESS_RATE_LIMITING_T Type
The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_address_rate_limiting_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_enabled number,
allowed_rate_per_address number,
max_delayed_count_per_address number,
block_response_code number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_rate_limiting_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_address_rate_limiting_t (
is_enabled number,
allowed_rate_per_address number,
max_delayed_count_per_address number,
block_response_code number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Enables or disables the address rate limiting Web Application Firewall feature. |
|
|
(optional) The number of allowed requests per second from one IP address. If unspecified, defaults to `1`. |
|
|
(optional) The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`. |
|
|
(optional) The response status code returned when a request is blocked. If unspecified, defaults to `503`. The list of available response codes: `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. |
DBMS_CLOUD_OCI_WAAS_BLOCK_CHALLENGE_SETTINGS_T Type
The challenge settings if `action` is set to `BLOCK`.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_block_challenge_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
block_action varchar2(32767),
block_response_code number,
block_error_page_message varchar2(32767),
block_error_page_description varchar2(32767),
block_error_page_code varchar2(32767),
captcha_title varchar2(32767),
captcha_header varchar2(32767),
captcha_footer varchar2(32767),
captcha_submit_label varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_block_challenge_settings_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_block_challenge_settings_t (
block_action varchar2,
block_response_code number,
block_error_page_message varchar2,
block_error_page_description varchar2,
block_error_page_code varchar2,
captcha_title varchar2,
captcha_header varchar2,
captcha_footer varchar2,
captcha_submit_label varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`. Allowed values are: 'SET_RESPONSE_CODE', 'SHOW_ERROR_PAGE', 'SHOW_CAPTCHA' |
|
|
(optional) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. |
|
|
(optional) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`. |
|
|
(optional) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.` |
|
|
(optional) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`. |
|
|
(optional) The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` |
|
|
(optional) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` |
|
|
(optional) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. |
|
|
(optional) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. |
DBMS_CLOUD_OCI_WAAS_CACHING_RULE_CRITERIA_T Type
A caching rule criteria condition and value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_caching_rule_criteria_t FORCE AUTHID CURRENT_USER IS OBJECT (
condition varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_criteria_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_criteria_t (
condition varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The condition of the caching rule criteria. - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored. Allowed values are: 'URL_IS', 'URL_STARTS_WITH', 'URL_PART_ENDS_WITH', 'URL_PART_CONTAINS' |
|
|
(required) The value of the caching rule criteria. |
DBMS_CLOUD_OCI_WAAS_CACHING_RULE_CRITERIA_TBL Type
Nested table type of dbms_cloud_oci_waas_caching_rule_criteria_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_caching_rule_criteria_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_caching_rule_criteria_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CACHING_RULE_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_caching_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
name varchar2(32767),
action varchar2(32767),
caching_duration varchar2(32767),
is_client_caching_enabled number,
client_caching_duration varchar2(32767),
criteria dbms_cloud_oci_waas_caching_rule_criteria_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_t (
key varchar2,
name varchar2,
action varchar2,
caching_duration varchar2,
is_client_caching_enabled number,
client_caching_duration varchar2,
criteria dbms_cloud_oci_waas_caching_rule_criteria_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The unique key for the caching rule. |
|
|
(required) The name of the caching rule. |
|
|
(required) The action to take when the criteria of a caching rule are met. - **CACHE:** Caches requested content when the criteria of the rule are met. - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met. Allowed values are: 'CACHE', 'BYPASS_CACHE' |
|
|
(optional) The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` |
|
|
(optional) Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses. |
|
|
(optional) The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` |
|
|
(required) The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions. |
DBMS_CLOUD_OCI_WAAS_CACHING_RULE_SUMMARY_T Type
The caching rule settings.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_caching_rule_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
name varchar2(32767),
action varchar2(32767),
caching_duration varchar2(32767),
is_client_caching_enabled number,
client_caching_duration varchar2(32767),
criteria dbms_cloud_oci_waas_caching_rule_criteria_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_caching_rule_summary_t (
key varchar2,
name varchar2,
action varchar2,
caching_duration varchar2,
is_client_caching_enabled number,
client_caching_duration varchar2,
criteria dbms_cloud_oci_waas_caching_rule_criteria_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The unique key for the caching rule. |
|
|
(required) The name of the caching rule. |
|
|
(required) The action to take when the criteria of a caching rule are met. - **CACHE:** Caches requested content when the criteria of the rule are met. - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met. Allowed values are: 'CACHE', 'BYPASS_CACHE' |
|
|
(optional) The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` |
|
|
(optional) Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses. |
|
|
(optional) The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` |
|
|
(required) The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions. |
DBMS_CLOUD_OCI_WAAS_CAPTCHA_T Type
The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots. *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_waas_captcha_t FORCE AUTHID CURRENT_USER IS OBJECT (
url varchar2(32767),
session_expiration_in_seconds number,
title varchar2(32767),
header_text varchar2(32767),
footer_text varchar2(32767),
failure_message varchar2(32767),
submit_label varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_captcha_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_captcha_t (
url varchar2,
session_expiration_in_seconds number,
title varchar2,
header_text varchar2,
footer_text varchar2,
failure_message varchar2,
submit_label varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique URL path at which to show the CAPTCHA challenge. |
|
|
(required) The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. |
|
|
(required) The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` |
|
|
(optional) The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.' |
|
|
(optional) The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.' |
|
|
(required) The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` |
|
|
(required) The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_SUBJECT_NAME_T Type
The entity to be secured by the certificate.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_certificate_subject_name_t FORCE AUTHID CURRENT_USER IS OBJECT (
country varchar2(32767),
state_province varchar2(32767),
locality varchar2(32767),
organization varchar2(32767),
organizational_unit varchar2(32767),
common_name varchar2(32767),
email_address varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_subject_name_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_subject_name_t (
country varchar2,
state_province varchar2,
locality varchar2,
organization varchar2,
organizational_unit varchar2,
common_name varchar2,
email_address varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website. |
|
|
(optional) The province where the organization is located. |
|
|
(optional) The city in which the organization is located. |
|
|
(optional) The organization name. |
|
|
(optional) The field to differentiate between divisions within an organization. |
|
|
(optional) The fully qualified domain name used for DNS lookups of the server. |
|
|
(optional) The email address of the server's administrator. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_ISSUER_NAME_T Type
The issuer of the certificate.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_certificate_issuer_name_t FORCE AUTHID CURRENT_USER IS OBJECT (
country varchar2(32767),
state_province varchar2(32767),
locality varchar2(32767),
organization varchar2(32767),
organizational_unit varchar2(32767),
common_name varchar2(32767),
email_address varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_issuer_name_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_issuer_name_t (
country varchar2,
state_province varchar2,
locality varchar2,
organization varchar2,
organizational_unit varchar2,
common_name varchar2,
email_address varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website. |
|
|
(optional) The province where the organization is located. |
|
|
(optional) The city in which the organization is located. |
|
|
(optional) The organization name. |
|
|
(optional) The field to differentiate between divisions within an organization. |
|
|
(optional) The Certificate Authority (CA) name. |
|
|
(optional) The email address of the server's administrator. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_PUBLIC_KEY_INFO_T Type
Information about the public key and the algorithm used by the public key.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_certificate_public_key_info_t FORCE AUTHID CURRENT_USER IS OBJECT (
algorithm varchar2(32767),
exponent number,
key_size number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_public_key_info_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_public_key_info_t (
algorithm varchar2,
exponent number,
key_size number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The algorithm identifier and parameters for the public key. |
|
|
(optional) The private key exponent. |
|
|
(optional) The number of bits in a key used by a cryptographic algorithm. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_EXTENSIONS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_certificate_extensions_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
is_critical number,
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_extensions_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_extensions_t (
name varchar2,
is_critical number,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The certificate extension name. |
|
|
(optional) The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored. |
|
|
(optional) The certificate extension value. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_EXTENSIONS_TBL Type
Nested table type of dbms_cloud_oci_waas_certificate_extensions_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_certificate_extensions_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_certificate_extensions_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CERTIFICATE_T Type
The details of the SSL certificate. **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_waas_certificate_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
issued_by varchar2(32767),
subject_name dbms_cloud_oci_waas_certificate_subject_name_t,
issuer_name dbms_cloud_oci_waas_certificate_issuer_name_t,
serial_number varchar2(32767),
version number,
signature_algorithm varchar2(32767),
time_not_valid_before timestamp with time zone,
time_not_valid_after timestamp with time zone,
public_key_info dbms_cloud_oci_waas_certificate_public_key_info_t,
extensions dbms_cloud_oci_waas_certificate_extensions_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
is_trust_verification_disabled number,
certificate_data varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
issued_by varchar2,
subject_name dbms_cloud_oci_waas_certificate_subject_name_t,
issuer_name dbms_cloud_oci_waas_certificate_issuer_name_t,
serial_number varchar2,
version number,
signature_algorithm varchar2,
time_not_valid_before timestamp with time zone,
time_not_valid_after timestamp with time zone,
public_key_info dbms_cloud_oci_waas_certificate_public_key_info_t,
extensions dbms_cloud_oci_waas_certificate_extensions_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2,
time_created timestamp with time zone,
is_trust_verification_disabled number,
certificate_data varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the certificate. |
|
|
(required) The OCID of the certificate's compartment. |
|
|
(required) The user-friendly name of the certificate. |
|
|
(optional) |
|
|
(optional) |
|
|
(optional) |
|
|
(required) A unique, positive integer assigned by the Certificate Authority (CA). The issuer name and serial number identify a unique certificate. |
|
|
(required) The version of the encoded certificate. |
|
|
(required) The identifier for the cryptographic algorithm used by the Certificate Authority (CA) to sign this certificate. |
|
|
(required) The date and time the certificate will become valid, expressed in RFC 3339 timestamp format. |
|
|
(required) The date and time the certificate will expire, expressed in RFC 3339 timestamp format. |
|
|
(optional) |
|
|
(optional) Additional attributes associated with users or public keys for managing relationships between Certificate Authorities. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(optional) The current lifecycle state of the SSL certificate. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the certificate was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) This indicates whether trust verification was disabled during the creation of SSL certificate. If `true` SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed. |
|
|
(optional) The data of the SSL certificate. |
DBMS_CLOUD_OCI_WAAS_CERTIFICATE_SUMMARY_T Type
A summary of the SSL certificate's information. **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_waas_certificate_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
time_not_valid_after timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_certificate_summary_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
time_not_valid_after timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2,
time_created timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the SSL certificate. |
|
|
(optional) The OCID of the SSL certificate's compartment. |
|
|
(optional) The user-friendly name of the SSL certificate. |
|
|
(optional) The date and time the certificate will expire, expressed in RFC 3339 timestamp format. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(optional) The current lifecycle state of the certificate. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the certificate was created, in the format defined by RFC3339. |
DBMS_CLOUD_OCI_WAAS_CHANGE_ADDRESS_LIST_COMPARTMENT_DETAILS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_change_address_list_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_address_list_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_address_list_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment. |
DBMS_CLOUD_OCI_WAAS_CHANGE_CERTIFICATE_COMPARTMENT_DETAILS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_change_certificate_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_certificate_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_certificate_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment. |
DBMS_CLOUD_OCI_WAAS_CHANGE_CUSTOM_PROTECTION_RULE_COMPARTMENT_DETAILS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_change_custom_protection_rule_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_custom_protection_rule_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_custom_protection_rule_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment. |
DBMS_CLOUD_OCI_WAAS_CHANGE_HTTP_REDIRECT_COMPARTMENT_DETAILS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_change_http_redirect_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_http_redirect_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_http_redirect_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the resource should be moved. |
DBMS_CLOUD_OCI_WAAS_CHANGE_WAAS_POLICY_COMPARTMENT_DETAILS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_change_waas_policy_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_waas_policy_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_change_waas_policy_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment. |
DBMS_CLOUD_OCI_WAAS_CREATE_ADDRESS_LIST_DETAILS_T Type
The data used to create a new address list of IP addresses and CIDR notations.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_create_address_list_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_address_list_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_address_list_details_t (
compartment_id varchar2,
display_name varchar2,
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment in which to create the address list. |
|
|
(required) A user-friendly name for the address list. |
|
|
(required) A list of IP addresses or CIDR notations. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_CREATE_CERTIFICATE_DETAILS_T Type
The data used to create a new SSL certificate. **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_waas_create_certificate_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
certificate_data varchar2(32767),
private_key_data varchar2(32767),
is_trust_verification_disabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_certificate_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_certificate_details_t (
compartment_id varchar2,
display_name varchar2,
certificate_data varchar2,
private_key_data varchar2,
is_trust_verification_disabled number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment in which to create the SSL certificate. |
|
|
(optional) A user-friendly name for the SSL certificate. The name can be changed and does not need to be unique. |
|
|
(required) The data of the SSL certificate. **Note:** Many SSL certificate providers require an intermediate certificate chain to ensure a trusted status. If your SSL certificate requires an intermediate certificate chain, please append the intermediate certificate key in the `certificateData` field after the leaf certificate issued by the SSL certificate provider. If you are unsure if your certificate requires an intermediate certificate chain, see your certificate provider's documentation. The example below shows an intermediate certificate appended to a leaf certificate. |
|
|
(required) The private key of the SSL certificate. |
|
|
(optional) Set to `true` if the SSL certificate is self-signed. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_CREATE_CUSTOM_PROTECTION_RULE_DETAILS_T Type
The required data to create a custom protection rule. For more information about custom protection rules, see Custom Protection 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_waas_create_custom_protection_rule_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
template varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_custom_protection_rule_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_custom_protection_rule_details_t (
compartment_id varchar2,
display_name varchar2,
description varchar2,
template varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment in which to create the custom protection rule. |
|
|
(required) A user-friendly name for the custom protection rule. |
|
|
(optional) A description for the Custom Protection rule. |
|
|
(required) The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language. Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule. `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example. `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated. *Example:* ``` SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 1/2.', \\ id: {{id_1}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" SecRule REQUEST_COOKIES \"regex matching SQL injection - part 2/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 2/2.', \\ id: {{id_2}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" ``` The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase. For more information about custom protection rules, see Custom Protection Rules. For more information about ModSecurity syntax, see Making Rules: The Basic Syntax. For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_HTTP_REDIRECT_TARGET_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_http_redirect_target_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_waas_http_redirect_target_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_http_redirect_target_t (
protocol varchar2,
host varchar2,
port number,
path varchar2,
query varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The protocol used for the target, http or https. Allowed values are: 'HTTP', 'HTTPS' |
|
|
(required) The host portion of the redirect. |
|
|
(optional) Port number of the target destination of the redirect, default to match protocol |
|
|
(required) The path component of the target URL (e.g., \"/path/to/resource\" in \"https://target.example.com/path/to/resource?redirected\"), which can be empty, static, or request-copying, or request-prefixing. Use of \\ is not permitted except to escape a following \\, {, or }. An empty value is treated the same as static \"/\". A static value must begin with a leading \"/\", optionally followed by other path characters. A request-copying value must exactly match \"{path}\", and will be replaced with the path component of the request URL (including its initial \"/\"). A request-prefixing value must start with \"/\" and end with a non-escaped \"{path}\", which will be replaced with the path component of the request URL (including its initial \"/\"). Only one such replacement token is allowed. |
|
|
(required) The query component of the target URL (e.g., \"?redirected\" in \"https://target.example.com/path/to/resource?redirected\"), which can be empty, static, or request-copying. Use of \\ is not permitted except to escape a following \\, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading \"?\", optionally followed by other query characters. A request-copying value must exactly match \"{query}\", and will be replaced with the query component of the request URL (including a leading \"?\" if and only if the request URL includes a query component). |
DBMS_CLOUD_OCI_WAAS_CREATE_HTTP_REDIRECT_DETAILS_T Type
The details of a HTTP Redirect configured to redirect traffic from one hostname to another. **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_waas_create_http_redirect_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_http_redirect_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_http_redirect_details_t (
compartment_id varchar2,
display_name varchar2,
domain varchar2,
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the HTTP Redirects compartment. |
|
|
(optional) The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique. |
|
|
(required) The domain from which traffic will be redirected. |
|
|
(required) The redirect target object including all the redirect data. |
|
|
(optional) The response code returned for the redirect to the client. For more information, see RFC 7231. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_HEADER_T Type
An HTTP header with name and value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_header_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_header_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_header_t (
name varchar2,
value varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The name of the header. |
|
|
(required) The value of the header. |
DBMS_CLOUD_OCI_WAAS_HEADER_TBL Type
Nested table type of dbms_cloud_oci_waas_header_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_header_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_header_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_ORIGIN_T Type
A detailed description of your web application's origin host server. An origin must be defined to set up WAF rules.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_origin_t FORCE AUTHID CURRENT_USER IS OBJECT (
uri varchar2(32767),
http_port number,
https_port number,
custom_headers dbms_cloud_oci_waas_header_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_t (
uri varchar2,
http_port number,
https_port number,
custom_headers dbms_cloud_oci_waas_header_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The URI of the origin. Does not support paths. Port numbers should be specified in the `httpPort` and `httpsPort` fields. |
|
|
(optional) The HTTP port on the origin that the web application listens on. If unspecified, defaults to `80`. If `0` is specified - the origin is not used for HTTP traffic. |
|
|
(optional) The HTTPS port on the origin that the web application listens on. If unspecified, defaults to `443`. If `0` is specified - the origin is not used for HTTPS traffic. |
|
|
(optional) A list of HTTP headers to forward to your origin. |
DBMS_CLOUD_OCI_WAAS_ORIGIN_GROUP_ORIGINS_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_origin_group_origins_t FORCE AUTHID CURRENT_USER IS OBJECT (
origin varchar2(32767),
weight number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_group_origins_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_group_origins_t (
origin varchar2,
weight number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The IP address or CIDR notation of the origin server. |
|
|
(optional) The weight of the origin used in load balancing. Origins with higher weights will receive larger proportions of client requests. |
DBMS_CLOUD_OCI_WAAS_ORIGIN_GROUP_ORIGINS_TBL Type
Nested table type of dbms_cloud_oci_waas_origin_group_origins_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_origin_group_origins_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_origin_group_origins_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_ORIGIN_GROUP_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_origin_group_t FORCE AUTHID CURRENT_USER IS OBJECT (
origins dbms_cloud_oci_waas_origin_group_origins_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_group_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_origin_group_t (
origins dbms_cloud_oci_waas_origin_group_origins_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The list of objects containing origin references and additional properties. |
DBMS_CLOUD_OCI_WAAS_LOAD_BALANCING_METHOD_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_load_balancing_method_t FORCE AUTHID CURRENT_USER IS OBJECT (
method varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_load_balancing_method_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_load_balancing_method_t (
method varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;Fields
| Field | Description |
|---|---|
|
|
(required) Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. - **IP_HASH:** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. - **ROUND_ROBIN:** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. - **STICKY_COOKIE:** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. Allowed values are: 'IP_HASH', 'ROUND_ROBIN', 'STICKY_COOKIE' |
DBMS_CLOUD_OCI_WAAS_HEALTH_CHECK_T Type
Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as \"healthy\".
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_health_check_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_enabled number,
method varchar2(32767),
path varchar2(32767),
headers json_element_t,
expected_response_code_group dbms_cloud_oci_waas_varchar2_tbl,
is_response_text_check_enabled number,
expected_response_text varchar2(32767),
interval_in_seconds number,
timeout_in_seconds number,
healthy_threshold number,
unhealthy_threshold number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_health_check_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_health_check_t (
is_enabled number,
method varchar2,
path varchar2,
headers json_element_t,
expected_response_code_group dbms_cloud_oci_waas_varchar2_tbl,
is_response_text_check_enabled number,
expected_response_text varchar2,
interval_in_seconds number,
timeout_in_seconds number,
healthy_threshold number,
unhealthy_threshold number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) Enables or disables the health checks. |
|
|
(optional) An HTTP verb (i.e. HEAD, GET, or POST) to use when performing the health check. Allowed values are: 'GET', 'HEAD', 'POST' |
|
|
(optional) Path to visit on your origins when performing the health check. |
|
|
(optional) HTTP header fields to include in health check requests, expressed as `\"name\": \"value\"` properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value \"waf health checks\". **Note:** The only currently-supported header fields are Host and User-Agent. |
|
|
(optional) The HTTP response codes that signify a healthy state. - **2XX:** Success response code group. - **3XX:** Redirection response code group. - **4XX:** Client errors response code group. - **5XX:** Server errors response code group. Allowed values are: '2XX', '3XX', '4XX', '5XX' |
|
|
(optional) Enables or disables additional check for predefined text in addition to response code. |
|
|
(optional) Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found. |
|
|
(optional) Time between health checks of an individual origin server, in seconds. |
|
|
(optional) Response timeout represents wait time until request is considered failed, in seconds. |
|
|
(optional) Number of successful health checks after which the server is marked up. |
|
|
(optional) Number of failed health checks after which the server is marked down. |
DBMS_CLOUD_OCI_WAAS_POLICY_CONFIG_T Type
The configuration details for the WAAS policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_policy_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
certificate_id varchar2(32767),
is_https_enabled number,
is_https_forced number,
tls_protocols dbms_cloud_oci_waas_varchar2_tbl,
is_origin_compression_enabled number,
is_behind_cdn number,
client_address_header varchar2(32767),
is_cache_control_respected number,
is_response_buffering_enabled number,
cipher_group varchar2(32767),
load_balancing_method dbms_cloud_oci_waas_load_balancing_method_t,
websocket_path_prefixes dbms_cloud_oci_waas_varchar2_tbl,
is_sni_enabled number,
health_checks dbms_cloud_oci_waas_health_check_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_policy_config_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_policy_config_t (
certificate_id varchar2,
is_https_enabled number,
is_https_forced number,
tls_protocols dbms_cloud_oci_waas_varchar2_tbl,
is_origin_compression_enabled number,
is_behind_cdn number,
client_address_header varchar2,
is_cache_control_respected number,
is_response_buffering_enabled number,
cipher_group varchar2,
load_balancing_method dbms_cloud_oci_waas_load_balancing_method_t,
websocket_path_prefixes dbms_cloud_oci_waas_varchar2_tbl,
is_sni_enabled number,
health_checks dbms_cloud_oci_waas_health_check_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the SSL certificate to use if HTTPS is supported. |
|
|
(optional) Enable or disable HTTPS support. If true, a `certificateId` is required. If unspecified, defaults to `false`. |
|
|
(optional) Force HTTP to HTTPS redirection. If unspecified, defaults to `false`. |
|
|
(optional) A list of allowed TLS protocols. Only applicable when HTTPS support is enabled. The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted. - **TLS_V1:** corresponds to TLS 1.0 specification. - **TLS_V1_1:** corresponds to TLS 1.1 specification. - **TLS_V1_2:** corresponds to TLS 1.2 specification. - **TLS_V1_3:** corresponds to TLS 1.3 specification. Enabled TLS protocols must go in a row. For example if `TLS_v1_1` and `TLS_V1_3` are enabled, `TLS_V1_2` must be enabled too. Allowed values are: 'TLS_V1', 'TLS_V1_1', 'TLS_V1_2', 'TLS_V1_3' |
|
|
(optional) Enable or disable GZIP compression of origin responses. If enabled, the header `Accept-Encoding: gzip` is sent to origin, otherwise, the empty `Accept-Encoding:` header is used. |
|
|
(optional) Enabling `isBehindCdn` allows for the collection of IP addresses from client requests if the WAF is connected to a CDN. |
|
|
(optional) Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if `isBehindCdn` is enabled. The edge node reads this header and its value and sets the client IP address as specified. It does not create the header if the header is not present in the request. If the header is not present, the connecting IP address will be used as the client's true IP address. It uses the last IP address in the header's value as the true IP address. Example: `X-Client-Ip: 11.1.1.1, 13.3.3.3` In the case of multiple headers with the same name, only the first header will be used. It is assumed that CDN sets the correct client IP address to prevent spoofing. - **X_FORWARDED_FOR:** Corresponds to `X-Forwarded-For` header name. - **X_CLIENT_IP:** Corresponds to `X-Client-Ip` header name. - **X_REAL_IP:** Corresponds to `X-Real-Ip` header name. - **CLIENT_IP:** Corresponds to `Client-Ip` header name. - **TRUE_CLIENT_IP:** Corresponds to `True-Client-Ip` header name. Allowed values are: 'X_FORWARDED_FOR', 'X_CLIENT_IP', 'X_REAL_IP', 'CLIENT_IP', 'TRUE_CLIENT_IP' |
|
|
(optional) Enable or disable automatic content caching based on the response `cache-control` header. This feature enables the origin to act as a proxy cache. Caching is usually defined using `cache-control` header. For example `cache-control: max-age=120` means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting. |
|
|
(optional) Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte. |
|
|
(optional) The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only. - **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA` Allowed values are: 'DEFAULT' |
|
|
(optional) An object that represents a load balancing method and its properties. |
|
|
(optional) ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of `websocketPathPrefixes` array value. In All other cases challenges, like JSC, HIC and etc., remain active. |
|
|
(optional) SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the 'handshake'-process. This allows a server to connect multiple SSL Certificates to one IP address and port. |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_DEVICE_FINGERPRINT_CHALLENGE_T Type
The device fingerprint challenge settings. The device fingerprint challenge generates hashed signatures of both virtual and real browsers to identify and block malicious bots.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_device_fingerprint_challenge_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_enabled number,
action varchar2(32767),
failure_threshold number,
action_expiration_in_seconds number,
failure_threshold_expiration_in_seconds number,
max_address_count number,
max_address_count_expiration_in_seconds number,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_device_fingerprint_challenge_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_device_fingerprint_challenge_t (
is_enabled number,
action varchar2,
failure_threshold number,
action_expiration_in_seconds number,
failure_threshold_expiration_in_seconds number,
max_address_count number,
max_address_count_expiration_in_seconds number,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Enables or disables the device fingerprint challenge Web Application Firewall feature. |
|
|
(optional) The action to take on requests from detected bots. If unspecified, defaults to `DETECT`. Allowed values are: 'DETECT', 'BLOCK' |
|
|
(optional) The number of failed requests allowed before taking action. If unspecified, defaults to `10`. |
|
|
(optional) The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`. |
|
|
(optional) The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. |
|
|
(optional) The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to `20`. |
|
|
(optional) The number of seconds before the maximum addresses count resets. If unspecified, defaults to `60`. |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_HUMAN_INTERACTION_CHALLENGE_T Type
The human interaction challenge settings. The human interaction challenge checks various event listeners in the user's browser to determine if there is a human user making a request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_human_interaction_challenge_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_enabled number,
action varchar2(32767),
failure_threshold number,
action_expiration_in_seconds number,
failure_threshold_expiration_in_seconds number,
interaction_threshold number,
recording_period_in_seconds number,
set_http_header dbms_cloud_oci_waas_header_t,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t,
is_nat_enabled number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_human_interaction_challenge_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_human_interaction_challenge_t (
is_enabled number,
action varchar2,
failure_threshold number,
action_expiration_in_seconds number,
failure_threshold_expiration_in_seconds number,
interaction_threshold number,
recording_period_in_seconds number,
set_http_header dbms_cloud_oci_waas_header_t,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t,
is_nat_enabled number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Enables or disables the human interaction challenge Web Application Firewall feature. |
|
|
(optional) The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. Allowed values are: 'DETECT', 'BLOCK' |
|
|
(optional) The number of failed requests before taking action. If unspecified, defaults to `10`. |
|
|
(optional) The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`. |
|
|
(optional) The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. |
|
|
(optional) The number of interactions required to pass the challenge. If unspecified, defaults to `3`. |
|
|
(optional) The number of seconds to record the interactions from the user. If unspecified, defaults to `15`. |
|
|
(optional) Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. |
|
|
(optional) |
|
|
(optional) When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. |
DBMS_CLOUD_OCI_WAAS_JS_CHALLENGE_T Type
The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_js_challenge_t FORCE AUTHID CURRENT_USER IS OBJECT (
is_enabled number,
action varchar2(32767),
failure_threshold number,
action_expiration_in_seconds number,
set_http_header dbms_cloud_oci_waas_header_t,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t,
are_redirects_challenged number,
criteria dbms_cloud_oci_waas_access_rule_criteria_tbl,
is_nat_enabled number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_js_challenge_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_js_challenge_t (
is_enabled number,
action varchar2,
failure_threshold number,
action_expiration_in_seconds number,
set_http_header dbms_cloud_oci_waas_header_t,
challenge_settings dbms_cloud_oci_waas_block_challenge_settings_t,
are_redirects_challenged number,
criteria dbms_cloud_oci_waas_access_rule_criteria_tbl,
is_nat_enabled number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Enables or disables the JavaScript challenge Web Application Firewall feature. |
|
|
(optional) The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. Allowed values are: 'DETECT', 'BLOCK' |
|
|
(optional) The number of failed requests before taking action. If unspecified, defaults to `10`. |
|
|
(optional) The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. |
|
|
(optional) Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. |
|
|
(optional) |
|
|
(optional) When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection. |
|
|
(optional) When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. |
|
|
(optional) When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. |
DBMS_CLOUD_OCI_WAAS_PROTECTION_RULE_EXCLUSION_T Type
Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the `exclusions` field, the protection rule will not be executed. Rules can have more than one exclusion and exclusions are applied to requests disjunctively, meaning the specified exclusion strings are independently matched against the specified targets of a request. The first target to match a specified string will trigger an exclusion. **Example:** If the following exclusions are defined for a protection rule: \"action\": \"BLOCK\", \"exclusions\": [ { \"target\":\"REQUEST_COOKIES\", \"exclusions\":[\"example.com\", \"12345\", \"219ffwef9w0f\"] }, { \"target\":\"REQUEST_COOKIE_NAMES\", \"exclusions\":[\"OAMAuthnCookie\", \"JSESSIONID\", \"HCM-PSJSESSIONID\"] } ], \"key\": \"1000000\", A request with the cookie name `sessionid` would trigger an exclusion. A request with the cookie name `yourcompany.com` would *not* trigger and exclusion.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_rule_exclusion_t FORCE AUTHID CURRENT_USER IS OBJECT (
target varchar2(32767),
exclusions dbms_cloud_oci_waas_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_exclusion_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_exclusion_t (
target varchar2,
exclusions dbms_cloud_oci_waas_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The target of the exclusion. Allowed values are: 'REQUEST_COOKIES', 'REQUEST_COOKIE_NAMES', 'ARGS', 'ARGS_NAMES' |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_PROTECTION_RULE_EXCLUSION_TBL Type
Nested table type of dbms_cloud_oci_waas_protection_rule_exclusion_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_rule_exclusion_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_protection_rule_exclusion_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CUSTOM_PROTECTION_RULE_SETTING_T Type
The OCID and action of a custom protection rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_custom_protection_rule_setting_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
action varchar2(32767),
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_setting_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_setting_t (
id varchar2,
action varchar2,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the custom protection rule. |
|
|
(optional) The action to take when the custom protection rule is triggered. `DETECT` - Logs the request when the criteria of the custom protection rule are met. `BLOCK` - Blocks the request when the criteria of the custom protection rule are met. Allowed values are: 'DETECT', 'BLOCK' |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_PROTECTION_SETTINGS_T Type
The settings used for protection rules.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
block_action varchar2(32767),
block_response_code number,
block_error_page_message varchar2(32767),
block_error_page_code varchar2(32767),
block_error_page_description varchar2(32767),
max_argument_count number,
max_name_length_per_argument number,
max_total_name_length_of_arguments number,
recommendations_period_in_days number,
is_response_inspected number,
max_response_size_in_ki_b number,
allowed_http_methods dbms_cloud_oci_waas_varchar2_tbl,
media_types dbms_cloud_oci_waas_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_settings_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_settings_t (
block_action varchar2,
block_response_code number,
block_error_page_message varchar2,
block_error_page_code varchar2,
block_error_page_description varchar2,
max_argument_count number,
max_name_length_per_argument number,
max_total_name_length_of_arguments number,
recommendations_period_in_days number,
is_response_inspected number,
max_response_size_in_ki_b number,
allowed_http_methods dbms_cloud_oci_waas_varchar2_tbl,
media_types dbms_cloud_oci_waas_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. Allowed values are: 'SHOW_ERROR_PAGE', 'SET_RESPONSE_CODE' |
|
|
(optional) The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. |
|
|
(optional) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' |
|
|
(optional) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. |
|
|
(optional) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` |
|
|
(optional) The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the \"Number of Arguments Limits\" rule (key: 960335). Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked: `GET /myapp/path?query=one&query=two&query=three` `POST /myapp/path` with Body `{\"argument1\":\"one\",\"argument2\":\"two\",\"argument3\":\"three\"}` |
|
|
(optional) The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the \"Values Limits\" rule (key: 960208). |
|
|
(optional) The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the \"Total Arguments Limits\" rule (key: 960341). |
|
|
(optional) The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`. Use `GET /waasPolicies/{waasPolicyId}/wafRecommendations` to view WAF recommendations. |
|
|
(optional) Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`. **Note:** Only origin responses with a Content-Type matching a value in `mediaTypes` will be inspected. |
|
|
(optional) The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`. |
|
|
(optional) The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the \"Restrict HTTP Request Methods\" rule (key: 911100). Allowed values are: 'OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'CONNECT', 'PATCH', 'PROPFIND' |
|
|
(optional) The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `[\"text/html\", \"text/plain\", \"text/xml\"]`. Supported MIME types include: - text/html - text/plain - text/asp - text/css - text/x-script - application/json - text/webviewhtml - text/x-java-source - application/x-javascript - application/javascript - application/ecmascript - text/javascript - text/ecmascript - text/x-script.perl - text/x-script.phyton - application/plain - application/xml - text/xml |
DBMS_CLOUD_OCI_WAAS_WHITELIST_T Type
An array of IP addresses that bypass the Web Application Firewall. Supports both single IP addresses or subnet masks (CIDR notation).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_whitelist_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
addresses dbms_cloud_oci_waas_varchar2_tbl,
address_lists dbms_cloud_oci_waas_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_whitelist_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_whitelist_t (
name varchar2,
addresses dbms_cloud_oci_waas_varchar2_tbl,
address_lists dbms_cloud_oci_waas_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique name of the whitelist. |
|
|
(optional) A set of IP addresses or CIDR notations to include in the whitelist. |
|
|
(optional) A list of OCID of IP address lists to include in the whitelist. |
DBMS_CLOUD_OCI_WAAS_ACCESS_RULE_TBL Type
Nested table type of dbms_cloud_oci_waas_access_rule_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_access_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_access_rule_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CAPTCHA_TBL Type
Nested table type of dbms_cloud_oci_waas_captcha_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_captcha_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_captcha_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CACHING_RULE_TBL Type
Nested table type of dbms_cloud_oci_waas_caching_rule_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_caching_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_caching_rule_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_CUSTOM_PROTECTION_RULE_SETTING_TBL Type
Nested table type of dbms_cloud_oci_waas_custom_protection_rule_setting_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_custom_protection_rule_setting_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_custom_protection_rule_setting_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WHITELIST_TBL Type
Nested table type of dbms_cloud_oci_waas_whitelist_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_whitelist_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_whitelist_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WAF_CONFIG_DETAILS_T Type
The Web Application Firewall configuration for the WAAS policy creation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
access_rules dbms_cloud_oci_waas_access_rule_tbl,
address_rate_limiting dbms_cloud_oci_waas_address_rate_limiting_t,
captchas dbms_cloud_oci_waas_captcha_tbl,
device_fingerprint_challenge dbms_cloud_oci_waas_device_fingerprint_challenge_t,
human_interaction_challenge dbms_cloud_oci_waas_human_interaction_challenge_t,
js_challenge dbms_cloud_oci_waas_js_challenge_t,
origin varchar2(32767),
caching_rules dbms_cloud_oci_waas_caching_rule_tbl,
custom_protection_rules dbms_cloud_oci_waas_custom_protection_rule_setting_tbl,
origin_groups dbms_cloud_oci_waas_varchar2_tbl,
protection_settings dbms_cloud_oci_waas_protection_settings_t,
whitelists dbms_cloud_oci_waas_whitelist_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_config_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_config_details_t (
access_rules dbms_cloud_oci_waas_access_rule_tbl,
address_rate_limiting dbms_cloud_oci_waas_address_rate_limiting_t,
captchas dbms_cloud_oci_waas_captcha_tbl,
device_fingerprint_challenge dbms_cloud_oci_waas_device_fingerprint_challenge_t,
human_interaction_challenge dbms_cloud_oci_waas_human_interaction_challenge_t,
js_challenge dbms_cloud_oci_waas_js_challenge_t,
origin varchar2,
caching_rules dbms_cloud_oci_waas_caching_rule_tbl,
custom_protection_rules dbms_cloud_oci_waas_custom_protection_rule_setting_tbl,
origin_groups dbms_cloud_oci_waas_varchar2_tbl,
protection_settings dbms_cloud_oci_waas_protection_settings_t,
whitelists dbms_cloud_oci_waas_whitelist_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The access rules applied to the Web Application Firewall. Access rules allow custom content access policies to be defined and `ALLOW`, `DETECT`, or `BLOCK` actions to be taken on a request when specified criteria are met. |
|
|
(optional) The settings used to limit the number of requests from an IP address. |
|
|
(optional) A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is attempting to reach the specified URL and not a bot. |
|
|
(optional) The device fingerprint challenge settings. Blocks bots based on unique device fingerprint information. |
|
|
(optional) The human interaction challenge settings. Detects natural human interactions such as mouse movements, time on site, and page scrolling to identify bots. |
|
|
(optional) The JavaScript challenge settings. Blocks bots by challenging requests from browsers that have no JavaScript support. |
|
|
(optional) The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but is not required upon updating the configuration. |
|
|
(optional) A list of caching rules applied to the web application. |
|
|
(optional) A list of the custom protection rule OCIDs and their actions. |
|
|
(optional) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. |
|
|
(optional) The settings applied to protection rules. |
|
|
(optional) A list of IP addresses that bypass the Web Application Firewall. |
DBMS_CLOUD_OCI_WAAS_CREATE_WAAS_POLICY_DETAILS_T Type
The required data to create a WAAS policy. **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_waas_create_waas_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_details_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_waas_policy_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_create_waas_policy_details_t (
compartment_id varchar2,
display_name varchar2,
domain varchar2,
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_details_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment in which to create the WAAS policy. |
|
|
(optional) A user-friendly name for the WAAS policy. The name can be changed and does not need to be unique. |
|
|
(required) The web application domain that the WAAS policy protects. |
|
|
(optional) An array of additional domains for the specified web application. |
|
|
(optional) A map of host to origin for the web application. The key should be a customer friendly name for the host, ex. primary, secondary, etc. |
|
|
(optional) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. |
|
|
(optional) |
|
|
(optional) |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_CUSTOM_PROTECTION_RULE_T Type
The details of a custom protection rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_custom_protection_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
template varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
description varchar2,
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
template varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the custom protection rule. |
|
|
(optional) The OCID of the custom protection rule's compartment. |
|
|
(optional) The user-friendly name of the custom protection rule. |
|
|
(optional) The description of the custom protection rule. |
|
|
(optional) The auto-generated ID for the custom protection rule. These IDs are referenced in logs. |
|
|
(optional) The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language. Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule. `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example. `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated. *Example:* ``` SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 1/2.', \\ id: {{id_1}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" SecRule REQUEST_COOKIES \"regex matching SQL injection - part 2/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 2/2.', \\ id: {{id_2}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" ``` The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase. For more information about custom protection rules, see Custom Protection Rules. For more information about ModSecurity syntax, see Making Rules: The Basic Syntax. For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation. |
|
|
(optional) The current lifecycle state of the custom protection rule. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the protection rule was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_CUSTOM_PROTECTION_RULE_SUMMARY_T Type
An overview of a custom protection rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_custom_protection_rule_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_custom_protection_rule_summary_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
lifecycle_state varchar2,
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the custom protection rule. |
|
|
(optional) The OCID of the custom protection rule's compartment. |
|
|
(optional) The user-friendly name of the custom protection rule. |
|
|
(optional) The auto-generated ID for the custom protection rule. These IDs are referenced in logs. |
|
|
(optional) The current lifecycle state of the custom protection rule. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the protection rule was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_EDGE_SUBNET_T Type
The details about an edge node subnet.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_edge_subnet_t FORCE AUTHID CURRENT_USER IS OBJECT (
cidr varchar2(32767),
time_modified timestamp with time zone,
l_region varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_edge_subnet_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_edge_subnet_t (
cidr varchar2,
time_modified timestamp with time zone,
l_region varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) An edge node subnet. This can include /24 or /8 addresses. |
|
|
(optional) The date and time the last change was made to the indicated edge node subnet, expressed in RFC 3339 timestamp format. |
|
|
(optional) The name of the region containing the indicated subnet. |
DBMS_CLOUD_OCI_WAAS_ERROR_T Type
An error code and message.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) |
|
|
(required) |
DBMS_CLOUD_OCI_WAAS_EXTEND_HTTP_RESPONSE_HEADER_ACTION_T Type
An object that represents the action of adding a header field to a response. If the header with specified value already exists, nothing will be added. If the header exists with different value, additional header name:value pair will be added. Comma separated header values are not considered individually (instead as a single value) when adding a new header field.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_extend_http_response_header_action_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_header_manipulation_action_t (
header varchar2(32767),
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_extend_http_response_header_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_extend_http_response_header_action_t (
action varchar2,
header varchar2,
value varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_extend_http_response_header_action_t is a subtype of the dbms_cloud_oci_waas_header_manipulation_action_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) A header field name that conforms to RFC 7230. Example: `example_header_name` |
|
|
(required) A header field value that conforms to RFC 7230. Example: `example_value` |
DBMS_CLOUD_OCI_WAAS_GOOD_BOT_T Type
The good bot settings. Good bots provides a list of bots which are managed by known providers.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_good_bot_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
name varchar2(32767),
is_enabled number,
description varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_good_bot_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_good_bot_t (
key varchar2,
name varchar2,
is_enabled number,
description varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique key for the bot. |
|
|
(optional) The bot name. |
|
|
(required) Enables or disables the bot. |
|
|
(optional) The description of the bot. |
DBMS_CLOUD_OCI_WAAS_HTTP_REDIRECT_T Type
The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target. **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_waas_http_redirect_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
time_created timestamp with time zone,
lifecycle_state varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_http_redirect_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_http_redirect_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
domain varchar2,
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
time_created timestamp with time zone,
lifecycle_state varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the HTTP Redirect. |
|
|
(optional) The OCID of the HTTP Redirect's compartment. |
|
|
(optional) The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique. |
|
|
(optional) The domain from which traffic will be redirected. |
|
|
(optional) The redirect target object including all the redirect data. |
|
|
(optional) The response code returned for the redirect to the client. For more information, see RFC 7231. |
|
|
(optional) The date and time the policy was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) The current lifecycle state of the HTTP Redirect. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_HTTP_REDIRECT_SUMMARY_T Type
The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target. **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_waas_http_redirect_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_http_redirect_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_http_redirect_summary_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
domain varchar2,
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
lifecycle_state varchar2,
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the HTTP Redirect. |
|
|
(optional) The OCID of the HTTP Redirect's compartment. |
|
|
(optional) The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique. |
|
|
(optional) The domain from which traffic will be redirected. |
|
|
(optional) The redirect target object including all the redirect data. |
|
|
(optional) The response code returned for the redirect to the client. For more information, see RFC 7231. |
|
|
(optional) The current lifecycle state of the HTTP Redirect. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the policy was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_IP_HASH_LOAD_BALANCING_METHOD_T Type
An object that represents the `ip-hash` load balancing method.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_ip_hash_load_balancing_method_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_load_balancing_method_t (
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_ip_hash_load_balancing_method_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_ip_hash_load_balancing_method_t (
method varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_ip_hash_load_balancing_method_t is a subtype of the dbms_cloud_oci_waas_load_balancing_method_t type.
DBMS_CLOUD_OCI_WAAS_PROTECTION_RULE_T Type
The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_rule_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
name varchar2(32767),
description varchar2(32767),
action varchar2(32767),
labels dbms_cloud_oci_waas_varchar2_tbl,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_t (
key varchar2,
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
name varchar2,
description varchar2,
action varchar2,
labels dbms_cloud_oci_waas_varchar2_tbl,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The unique key of the protection rule. |
|
|
(optional) The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation. |
|
|
(optional) The name of the protection rule. |
|
|
(optional) The description of the protection rule. |
|
|
(optional) The action to take when the traffic is detected as malicious. If unspecified, defaults to `OFF`. Allowed values are: 'OFF', 'DETECT', 'BLOCK' |
|
|
(optional) The list of labels for the protection rule. **Note:** Protection rules with a `ResponseBody` label will have no effect unless `isResponseInspected` is true. |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_PROTECTION_RULE_ACTION_T Type
A protection rule key and the associated action to apply to that rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_rule_action_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
action varchar2(32767),
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_protection_rule_action_t (
key varchar2,
action varchar2,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique key of the protection rule. |
|
|
(required) The action to apply to the protection rule. If unspecified, defaults to `OFF`. Allowed values are: 'OFF', 'DETECT', 'BLOCK' |
|
|
(optional) The types of requests excluded from the protection rule action. If the requests matches the criteria in the `exclusions`, the protection rule action will not be executed. |
DBMS_CLOUD_OCI_WAAS_PURGE_CACHE_T Type
The list of cached resources to purge. If a resource is not specified, the purge targets all rules in a policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_purge_cache_t FORCE AUTHID CURRENT_USER IS OBJECT (
resources dbms_cloud_oci_waas_varchar2_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_purge_cache_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_purge_cache_t (
resources dbms_cloud_oci_waas_varchar2_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A resource to purge, specified by either a hostless absolute path starting with a single slash (Example: `/path/to/resource`) or by a relative path in which the first component will be interpreted as a domain protected by the WAAS policy (Example: `example.com/path/to/resource`). |
DBMS_CLOUD_OCI_WAAS_RECOMMENDATION_T Type
A recommended protection rule for a web application. This recommendation can be accepted to apply it to the Web Application Firewall configuration for this policy. Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended protection rules.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_recommendation_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
name varchar2(32767),
description varchar2(32767),
labels dbms_cloud_oci_waas_varchar2_tbl,
recommended_action varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_recommendation_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_recommendation_t (
key varchar2,
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
name varchar2,
description varchar2,
labels dbms_cloud_oci_waas_varchar2_tbl,
recommended_action varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The unique key for the recommended protection rule. |
|
|
(optional) The list of the ModSecurity rule IDs associated with the protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation. |
|
|
(optional) The name of the recommended protection rule. |
|
|
(optional) The description of the recommended protection rule. |
|
|
(optional) The list of labels for the recommended protection rule. |
|
|
(optional) The recommended action to apply to the protection rule. |
DBMS_CLOUD_OCI_WAAS_REMOVE_HTTP_RESPONSE_HEADER_ACTION_T Type
An object that represents the action of removing from a response all occurrences of header fields with a specified name.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_remove_http_response_header_action_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_header_manipulation_action_t (
header varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_remove_http_response_header_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_remove_http_response_header_action_t (
action varchar2,
header varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_remove_http_response_header_action_t is a subtype of the dbms_cloud_oci_waas_header_manipulation_action_t type.
Fields
| Field | Description |
|---|---|
|
|
(required) A header field name that conforms to RFC 7230. Example: `example_header_name` |
DBMS_CLOUD_OCI_WAAS_ROUND_ROBIN_LOAD_BALANCING_METHOD_T Type
An object that represents the `round-robin` load balancing method.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_round_robin_load_balancing_method_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_load_balancing_method_t (
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_round_robin_load_balancing_method_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_round_robin_load_balancing_method_t (
method varchar2
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_round_robin_load_balancing_method_t is a subtype of the dbms_cloud_oci_waas_load_balancing_method_t type.
DBMS_CLOUD_OCI_WAAS_STICKY_COOKIE_LOAD_BALANCING_METHOD_T Type
An object that represents the `sticky-cookie` load balancing method and its properties.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_sticky_cookie_load_balancing_method_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_waas_load_balancing_method_t (
name varchar2(32767),
domain varchar2(32767),
expiration_time_in_seconds number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_sticky_cookie_load_balancing_method_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_sticky_cookie_load_balancing_method_t (
method varchar2,
name varchar2,
domain varchar2,
expiration_time_in_seconds number
) RETURN SELF AS RESULT
);dbms_cloud_oci_waas_sticky_cookie_load_balancing_method_t is a subtype of the dbms_cloud_oci_waas_load_balancing_method_t type.
Fields
| Field | Description |
|---|---|
|
|
(optional) The name of the cookie used to track the persistence. Can contain any US-ASCII character except separator or control character. |
|
|
(optional) The domain for which the cookie is set, defaults to WAAS policy domain. |
|
|
(optional) The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session. |
DBMS_CLOUD_OCI_WAAS_THREAT_FEED_T Type
The settings of the threat intelligence feed. You can block requests from IP addresses based on their reputations with various commercial and open source threat feeds.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_threat_feed_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
name varchar2(32767),
action varchar2(32767),
description varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_threat_feed_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_threat_feed_t (
key varchar2,
name varchar2,
action varchar2,
description varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The unique key of the threat intelligence feed. |
|
|
(optional) The name of the threat intelligence feed. |
|
|
(optional) The action to take when traffic is flagged as malicious by data from the threat intelligence feed. If unspecified, defaults to `OFF`. Allowed values are: 'OFF', 'DETECT', 'BLOCK' |
|
|
(optional) The description of the threat intelligence feed. |
DBMS_CLOUD_OCI_WAAS_THREAT_FEED_ACTION_T Type
The action to take for a request that has been determined to be potentially malicious.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_threat_feed_action_t FORCE AUTHID CURRENT_USER IS OBJECT (
key varchar2(32767),
action varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_threat_feed_action_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_threat_feed_action_t (
key varchar2,
action varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The unique key of the object for which the action applies. |
|
|
(required) The selected action. If unspecified, defaults to `OFF`. Allowed values are: 'OFF', 'DETECT', 'BLOCK' |
DBMS_CLOUD_OCI_WAAS_UPDATE_ADDRESS_LIST_DETAILS_T Type
The data used to update the address list: IP addresses and CIDR notations.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_update_address_list_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_address_list_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_address_list_details_t (
display_name varchar2,
addresses dbms_cloud_oci_waas_varchar2_tbl,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user-friendly name for the address list. |
|
|
(optional) A list of IP addresses or CIDR notations. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_UPDATE_CERTIFICATE_DETAILS_T Type
The data used to create a new SSL certificate. **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_waas_update_certificate_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_waas_update_certificate_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_certificate_details_t (
display_name varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user-friendly name for the SSL certificate. The name can be changed and does not need to be unique. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_UPDATE_CUSTOM_PROTECTION_RULE_DETAILS_T Type
Updates the configuration details of a custom protection rule. Custom protection rules can only be updated if they are not active in a WAAS policy. **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_waas_update_custom_protection_rule_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
template varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_custom_protection_rule_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_custom_protection_rule_details_t (
display_name varchar2,
description varchar2,
template varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user-friendly name for the custom protection rule. |
|
|
(optional) A description for the custom protection rule. |
|
|
(optional) The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language. Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule. `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example. `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated. *Example:* ``` SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 1/2.', \\ id: {{id_1}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" SecRule REQUEST_COOKIES \"regex matching SQL injection - part 2/2\" \\ \"phase:2, \\ msg:'Detects chained SQL injection attempts 2/2.', \\ id: {{id_2}}, \\ ctl:ruleEngine={{mode}}, \\ deny\" ``` The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase. For more information about custom protection rules, see Custom Protection Rules. For more information about ModSecurity syntax, see Making Rules: The Basic Syntax. For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_UPDATE_HTTP_REDIRECT_DETAILS_T Type
The details of a HTTP Redirect configured to redirect traffic from one hostname to another. **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_waas_update_http_redirect_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_http_redirect_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_http_redirect_details_t (
display_name varchar2,
target dbms_cloud_oci_waas_http_redirect_target_t,
response_code number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique. |
|
|
(optional) The redirect target object including all the redirect data. |
|
|
(optional) The response code returned for the redirect to the client. For more information, see RFC 7231. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_GOOD_BOT_TBL Type
Nested table type of dbms_cloud_oci_waas_good_bot_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_good_bot_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_good_bot_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_PROTECTION_RULE_TBL Type
Nested table type of dbms_cloud_oci_waas_protection_rule_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_protection_rule_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_protection_rule_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_THREAT_FEED_TBL Type
Nested table type of dbms_cloud_oci_waas_threat_feed_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_threat_feed_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_threat_feed_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WAF_CONFIG_T Type
The Web Application Firewall configuration for the WAAS policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
access_rules dbms_cloud_oci_waas_access_rule_tbl,
address_rate_limiting dbms_cloud_oci_waas_address_rate_limiting_t,
captchas dbms_cloud_oci_waas_captcha_tbl,
device_fingerprint_challenge dbms_cloud_oci_waas_device_fingerprint_challenge_t,
good_bots dbms_cloud_oci_waas_good_bot_tbl,
human_interaction_challenge dbms_cloud_oci_waas_human_interaction_challenge_t,
js_challenge dbms_cloud_oci_waas_js_challenge_t,
origin varchar2(32767),
caching_rules dbms_cloud_oci_waas_caching_rule_tbl,
custom_protection_rules dbms_cloud_oci_waas_custom_protection_rule_setting_tbl,
origin_groups dbms_cloud_oci_waas_varchar2_tbl,
protection_rules dbms_cloud_oci_waas_protection_rule_tbl,
protection_settings dbms_cloud_oci_waas_protection_settings_t,
threat_feeds dbms_cloud_oci_waas_threat_feed_tbl,
whitelists dbms_cloud_oci_waas_whitelist_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_config_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_config_t (
access_rules dbms_cloud_oci_waas_access_rule_tbl,
address_rate_limiting dbms_cloud_oci_waas_address_rate_limiting_t,
captchas dbms_cloud_oci_waas_captcha_tbl,
device_fingerprint_challenge dbms_cloud_oci_waas_device_fingerprint_challenge_t,
good_bots dbms_cloud_oci_waas_good_bot_tbl,
human_interaction_challenge dbms_cloud_oci_waas_human_interaction_challenge_t,
js_challenge dbms_cloud_oci_waas_js_challenge_t,
origin varchar2,
caching_rules dbms_cloud_oci_waas_caching_rule_tbl,
custom_protection_rules dbms_cloud_oci_waas_custom_protection_rule_setting_tbl,
origin_groups dbms_cloud_oci_waas_varchar2_tbl,
protection_rules dbms_cloud_oci_waas_protection_rule_tbl,
protection_settings dbms_cloud_oci_waas_protection_settings_t,
threat_feeds dbms_cloud_oci_waas_threat_feed_tbl,
whitelists dbms_cloud_oci_waas_whitelist_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The access rules applied to the Web Application Firewall. Used for defining custom access policies with the combination of `ALLOW`, `DETECT`, and `BLOCK` rules, based on different criteria. |
|
|
(optional) The IP address rate limiting settings used to limit the number of requests from an address. |
|
|
(optional) A list of CAPTCHA challenge settings. These are used to challenge requests with a CAPTCHA to block bots. |
|
|
(optional) The device fingerprint challenge settings. Used to detect unique devices based on the device fingerprint information collected in order to block bots. |
|
|
(optional) A list of bots allowed to access the web application. |
|
|
(optional) The human interaction challenge settings. Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots. |
|
|
(optional) The JavaScript challenge settings. Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots. |
|
|
(optional) The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. |
|
|
(optional) A list of caching rules applied to the web application. |
|
|
(optional) A list of the custom protection rule OCIDs and their actions. |
|
|
(optional) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. |
|
|
(optional) A list of the protection rules and their details. |
|
|
(optional) The settings to apply to protection rules. |
|
|
(optional) A list of threat intelligence feeds and the actions to apply to known malicious traffic based on internet intelligence. |
|
|
(optional) A list of IP addresses that bypass the Web Application Firewall. |
DBMS_CLOUD_OCI_WAAS_UPDATE_WAAS_POLICY_DETAILS_T Type
Updates the configuration details of a WAAS policy. **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_waas_update_waas_policy_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_waas_policy_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_update_waas_policy_details_t (
display_name varchar2,
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A user-friendly name for the WAAS policy. The name can be changed and does not need to be unique. |
|
|
(optional) An array of additional domains protected by this WAAS policy. |
|
|
(optional) A map of host to origin for the web application. The key should be a customer friendly name for the host, ex. primary, secondary, etc. |
|
|
(optional) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. |
|
|
(optional) |
|
|
(optional) |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_WAAS_POLICY_T Type
The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web application. **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_waas_waas_policy_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
cname varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_t,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
domain varchar2,
additional_domains dbms_cloud_oci_waas_varchar2_tbl,
cname varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
origins json_element_t,
origin_groups json_element_t,
policy_config dbms_cloud_oci_waas_policy_config_t,
waf_config dbms_cloud_oci_waas_waf_config_t,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the WAAS policy. |
|
|
(optional) The OCID of the WAAS policy's compartment. |
|
|
(optional) The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique. |
|
|
(optional) The web application domain that the WAAS policy protects. |
|
|
(optional) An array of additional domains for this web application. |
|
|
(optional) The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF. |
|
|
(optional) The current lifecycle state of the WAAS policy. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the policy was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. **Examples:** `primary` or `secondary`. |
|
|
(optional) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. |
|
|
(optional) |
|
|
(optional) |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_WAAS_POLICY_CUSTOM_PROTECTION_RULE_SUMMARY_T Type
The OCID and action of a custom protection rule.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waas_policy_custom_protection_rule_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
action varchar2(32767),
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_custom_protection_rule_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_custom_protection_rule_summary_t (
id varchar2,
display_name varchar2,
action varchar2,
mod_security_rule_ids dbms_cloud_oci_waas_varchar2_tbl,
exclusions dbms_cloud_oci_waas_protection_rule_exclusion_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the custom protection rule. |
|
|
(optional) The user-friendly name of the custom protection rule. |
|
|
(optional) The action to take when the custom protection rule is triggered. `DETECT` - Logs the request when the criteria of the custom protection rule are met. `BLOCK` - Blocks the request when the criteria of the custom protection rule are met. Allowed values are: 'DETECT', 'BLOCK' |
|
|
(optional) The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation. |
|
|
(optional) |
DBMS_CLOUD_OCI_WAAS_WAAS_POLICY_SUMMARY_T Type
Summary information about a WAAS policy. **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_waas_waas_policy_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
domain varchar2(32767),
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waas_policy_summary_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
domain varchar2,
lifecycle_state varchar2,
time_created timestamp with time zone,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The OCID of the WAAS policy. |
|
|
(optional) The OCID of the WAAS policy's compartment. |
|
|
(optional) The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique. |
|
|
(optional) The web application domain that the WAAS policy protects. |
|
|
(optional) The current lifecycle state of the WAAS policy. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'UPDATING', 'DELETING', 'DELETED' |
|
|
(optional) The date and time the policy was created, expressed in RFC 3339 timestamp format. |
|
|
(optional) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_WAAS_WAF_BLOCKED_REQUEST_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_blocked_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
time_observed timestamp with time zone,
time_range_in_seconds number,
waf_feature varchar2(32767),
l_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_blocked_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_blocked_request_t (
time_observed timestamp with time zone,
time_range_in_seconds number,
waf_feature varchar2,
l_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The date and time the blocked requests were observed, expressed in RFC 3339 timestamp format. |
|
|
(optional) The number of seconds the data covers. |
|
|
(optional) The specific Web Application Firewall feature that blocked the requests, such as JavaScript Challenge or Access Control. Allowed values are: 'PROTECTION_RULES', 'JS_CHALLENGE', 'ACCESS_RULES', 'THREAT_FEEDS', 'HUMAN_INTERACTION_CHALLENGE', 'DEVICE_FINGERPRINT_CHALLENGE', 'CAPTCHA', 'ADDRESS_RATE_LIMITING' |
|
|
(optional) The count of blocked requests. |
DBMS_CLOUD_OCI_WAAS_WAF_LOG_T Type
A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode. For more information about WAF logs, see Logs.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_log_t FORCE AUTHID CURRENT_USER IS OBJECT (
action varchar2(32767),
captcha_action varchar2(32767),
captcha_expected varchar2(32767),
captcha_received varchar2(32767),
captcha_fail_count varchar2(32767),
client_address varchar2(32767),
country_name varchar2(32767),
user_agent varchar2(32767),
domain varchar2(32767),
protection_rule_detections json_element_t,
http_method varchar2(32767),
request_url varchar2(32767),
http_headers json_element_t,
referrer varchar2(32767),
response_code number,
response_size number,
incident_key varchar2(32767),
fingerprint varchar2(32767),
device varchar2(32767),
country_code varchar2(32767),
request_headers json_element_t,
threat_feed_key varchar2(32767),
access_rule_key varchar2(32767),
address_rate_limiting_key varchar2(32767),
l_timestamp timestamp with time zone,
log_type varchar2(32767),
origin_address varchar2(32767),
origin_response_time varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_log_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_log_t (
action varchar2,
captcha_action varchar2,
captcha_expected varchar2,
captcha_received varchar2,
captcha_fail_count varchar2,
client_address varchar2,
country_name varchar2,
user_agent varchar2,
domain varchar2,
protection_rule_detections json_element_t,
http_method varchar2,
request_url varchar2,
http_headers json_element_t,
referrer varchar2,
response_code number,
response_size number,
incident_key varchar2,
fingerprint varchar2,
device varchar2,
country_code varchar2,
request_headers json_element_t,
threat_feed_key varchar2,
access_rule_key varchar2,
address_rate_limiting_key varchar2,
l_timestamp timestamp with time zone,
log_type varchar2,
origin_address varchar2,
origin_response_time varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The action taken on the request, either `ALLOW`, `DETECT`, or `BLOCK`. |
|
|
(optional) The CAPTCHA action taken on the request, `ALLOW` or `BLOCK`. For more information about CAPTCHAs, see `UpdateCaptchas`. |
|
|
(optional) The CAPTCHA challenge answer that was expected. |
|
|
(optional) The CAPTCHA challenge answer that was received. |
|
|
(optional) The number of times the CAPTCHA challenge was failed. |
|
|
(optional) The IPv4 address of the requesting client. |
|
|
(optional) The name of the country where the request originated. |
|
|
(optional) The value of the request's `User-Agent` header field. |
|
|
(optional) The `Host` header data of the request. |
|
|
(optional) A map of protection rule keys to detection message details. Detections are requests that matched the criteria of a protection rule but the rule's action was set to `DETECT`. |
|
|
(optional) The HTTP method of the request. |
|
|
(optional) The path and query string of the request. |
|
|
(optional) The map of the request's header names to their respective values. |
|
|
(optional) The `Referrer` header value of the request. |
|
|
(optional) The status code of the response. |
|
|
(optional) The size in bytes of the response. |
|
|
(optional) The incident key of a request. An incident key is generated for each request processed by the Web Application Firewall and is used to idenitfy blocked requests in applicable logs. |
|
|
(optional) The hashed signature of the device's fingerprint. For more information, see `DeviceFingerPrintChallenge`. |
|
|
(optional) The type of device that the request was made from. |
|
|
(optional) ISO 3166-1 alpha-2 code of the country from which the request originated. For a list of codes, see ISO's website. |
|
|
(optional) A map of header names to values of the request sent to the origin, including any headers appended by the Web Application Firewall. |
|
|
(optional) The `ThreatFeed` key that matched the request. For more information about threat feeds, see `UpdateThreatFeeds`. |
|
|
(optional) The `AccessRule` key that matched the request. For more information about access rules, see `UpdateAccessRules`. |
|
|
(optional) The `AddressRateLimiting` key that matched the request. For more information about address rate limiting, see `UpdateWafAddressRateLimiting`. |
|
|
(optional) The date and time the Web Application Firewall processed the request and logged it. |
|
|
(optional) The type of log of the request. For more about log types, see Logs. |
|
|
(optional) The address of the origin server where the request was sent. |
|
|
(optional) The amount of time it took the origin server to respond to the request, in seconds. |
DBMS_CLOUD_OCI_WAAS_WAF_METER_DATUM_T Type
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_meter_datum_t FORCE AUTHID CURRENT_USER IS OBJECT (
time_observed timestamp with time zone,
time_range_in_seconds number,
tenancy_id varchar2(32767),
compartment_id varchar2(32767),
waas_policy_id varchar2(32767),
is_oci_origin number,
is_bot_enabled number,
request_count number,
traffic_in_bytes number,
tag_slug clob,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_meter_datum_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_meter_datum_t (
time_observed timestamp with time zone,
time_range_in_seconds number,
tenancy_id varchar2,
compartment_id varchar2,
waas_policy_id varchar2,
is_oci_origin number,
is_bot_enabled number,
request_count number,
traffic_in_bytes number,
tag_slug clob
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The date and time the traffic was observed, rounded down to the start of a range, and expressed in RFC 3339 timestamp format. |
|
|
(optional) The number of seconds this data covers. |
|
|
(optional) The tenancy OCID of the data. |
|
|
(optional) The compartment OCID of the data. |
|
|
(optional) The policy OCID of the data. |
|
|
(optional) True if origin (endpoint) is an OCI resource. False if external. |
|
|
(optional) True if bot manager is enabled. |
|
|
(optional) The number of incoming requests. |
|
|
(optional) Traffic in bytes. |
|
|
(optional) The tag slug for the specified `waasPolicyId`. |
DBMS_CLOUD_OCI_WAAS_WAF_REQUEST_T Type
A time series of request counts handled by the Web Application Firewall, including blocked requests.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
time_observed timestamp with time zone,
time_range_in_seconds number,
l_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_request_t (
time_observed timestamp with time zone,
time_range_in_seconds number,
l_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The date and time the traffic was observed, rounded down to the start of a range, and expressed in RFC 3339 timestamp format. |
|
|
(optional) The number of seconds this data covers. |
|
|
(optional) The total number of requests received in this time period. |
DBMS_CLOUD_OCI_WAAS_WAF_TRAFFIC_DATUM_T Type
A time series of traffic data for the Web Application Firewall configured for a policy.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_waf_traffic_datum_t FORCE AUTHID CURRENT_USER IS OBJECT (
time_observed timestamp with time zone,
time_range_in_seconds number,
tenancy_id varchar2(32767),
compartment_id varchar2(32767),
waas_policy_id varchar2(32767),
traffic_in_bytes number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_traffic_datum_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_waf_traffic_datum_t (
time_observed timestamp with time zone,
time_range_in_seconds number,
tenancy_id varchar2,
compartment_id varchar2,
waas_policy_id varchar2,
traffic_in_bytes number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The date and time the traffic was observed, rounded down to the start of the range, and expressed in RFC 3339 timestamp format. |
|
|
(optional) The number of seconds this data covers. |
|
|
(optional) The tenancy OCID of the data. |
|
|
(optional) The compartment OCID of the data. |
|
|
(optional) The policy OCID of the data. |
|
|
(optional) Traffic in bytes. |
DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_RESOURCE_T Type
The resource on which the work request is operating.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
action_type varchar2(32767),
entity_type varchar2(32767),
identifier varchar2(32767),
entity_uri varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_resource_t (
action_type varchar2,
entity_type varchar2,
identifier varchar2,
entity_uri varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) How the work request affects the resource. Allowed values are: 'IN_PROGRESS', 'CREATED', 'UPDATED', 'DELETED', 'RELATED', 'PURGED' |
|
|
(optional) The resource type the work request affects. |
|
|
(optional) The OCID of the resource that the work request affects. |
|
|
(optional) The URI path used while performing a `GET` to access the resource metadata. |
DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_LOG_ENTRY_T Type
A log message for a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_log_entry_t (
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The log message. |
|
|
(optional) The date and time the work request log event happend, expressed in RFC 3339 timestamp format. |
DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_ERROR_T Type
An object returned in the event of a work request error.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_error_t (
code varchar2,
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A machine-usable code for the error that occurred. |
|
|
(optional) The error message. |
|
|
(optional) The date and time the work request error happened, expressed in RFC 3339 timestamp format. |
DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_RESOURCE_TBL Type
Nested table type of dbms_cloud_oci_waas_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_work_request_resource_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_LOG_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_waas_work_request_log_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_work_request_log_entry_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_ERROR_TBL Type
Nested table type of dbms_cloud_oci_waas_work_request_error_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_waas_work_request_error_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_T Type
Many of the API requests you use to create and configure WAAS policies 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_waas_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
operation_type varchar2(32767),
status varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_waas_work_request_resource_tbl,
percent_complete number,
logs dbms_cloud_oci_waas_work_request_log_entry_tbl,
errors dbms_cloud_oci_waas_work_request_error_tbl,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_t (
id varchar2,
operation_type varchar2,
status varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_waas_work_request_resource_tbl,
percent_complete number,
logs dbms_cloud_oci_waas_work_request_log_entry_tbl,
errors dbms_cloud_oci_waas_work_request_error_tbl,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the work request. |
|
|
(required) A description of the operation requested by the work request. Allowed values are: 'CREATE_WAAS_POLICY', 'UPDATE_WAAS_POLICY', 'DELETE_WAAS_POLICY', 'CREATE_HTTP_REDIRECT', 'UPDATE_HTTP_REDIRECT', 'DELETE_HTTP_REDIRECT', 'PURGE_WAAS_POLICY_CACHE', 'CREATE_CUSTOM_PROTECTION_RULE', 'UPDATE_CUSTOM_PROTECTION_RULE', 'DELETE_CUSTOM_PROTECTION_RULE' |
|
|
(required) The current status of the work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The OCID of the compartment that contains the work request. |
|
|
(optional) The resources being used to complete the work request operation. |
|
|
(optional) The percentage of work completed by the work request. |
|
|
(optional) The list of log entries from the work request workflow. |
|
|
(optional) The list of errors that occurred while fulfilling the work request. |
|
|
(required) The date and time the work request was created, in the format defined by RFC3339. |
|
|
(required) The date and time the work request moved from the `ACCEPTED` state to the `IN_PROGRESS` state, expressed in RFC 3339 timestamp format. |
|
|
(required) The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format. |
DBMS_CLOUD_OCI_WAAS_WORK_REQUEST_SUMMARY_T Type
The summarized details of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_waas_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
operation_type varchar2(32767),
status varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_waas_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_waas_work_request_summary_t (
id varchar2,
operation_type varchar2,
status varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_waas_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the work request. |
|
|
(required) A description of the operation requested by the work request. Allowed values are: 'CREATE_WAAS_POLICY', 'UPDATE_WAAS_POLICY', 'DELETE_WAAS_POLICY', 'CREATE_HTTP_REDIRECT', 'UPDATE_HTTP_REDIRECT', 'DELETE_HTTP_REDIRECT', 'PURGE_WAAS_POLICY_CACHE', 'CREATE_CUSTOM_PROTECTION_RULE', 'UPDATE_CUSTOM_PROTECTION_RULE', 'DELETE_CUSTOM_PROTECTION_RULE' |
|
|
(required) The current status of the work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
|
(required) The OCID of the compartment that contains the work request. |
|
|
(optional) The resources being used to complete the work request operation. |
|
|
(optional) The percentage of work completed by the work request. |
|
|
(required) The date and time the work request was created, expressed in RFC 3339 timestamp format. |
|
|
(required) The date and time the work request moved from the `ACCEPTED` state to the `IN_PROGRESS` state, expressed in RFC 3339 timestamp format. |
|
|
(required) The date and time the work request was fulfilled or terminated, in the format defined by RFC3339. |