Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WebAppFirewallPolicy

The details of WebAppFirewallPolicy. A policy is comprised of rules, which allows executing inspections of incoming/outgoing HTTP message parameters and execution of actions, based on results of rules execution.

In policy, rules are grouped into modules by their functionality. Modules can be further divided by the type of HTTP messages they handle: Modules that inspect incoming HTTP request. These modules are executed in the order they are enumerated here: * requestAccessControl * requestRateLimiting * requestProtection

Modules that inspect outgoing HTTP responses. These modules are executed in the order they are enumerated here: * responseAccessControl * responseProtection

Properties

Optional actions

actions: Array<Action>

Predefined actions for use in multiple different rules. Not all actions are supported in every module. Some actions terminate further execution of modules and rules in a module and some do not. Actions names must be unique within this array.

compartmentId

compartmentId: string

The OCID of the compartment.

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

WebAppFirewallPolicy display name, can be renamed.

freeformTags

freeformTags: object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the WebAppFirewallPolicy.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

lifecycleState

lifecycleState: LifecycleState

The current state of the WebAppFirewallPolicy.

Optional requestAccessControl

requestAccessControl: model.RequestAccessControl

Optional requestProtection

requestProtection: model.RequestProtection

Optional requestRateLimiting

requestRateLimiting: model.RequestRateLimiting

Optional responseAccessControl

responseAccessControl: model.ResponseAccessControl

Optional responseProtection

responseProtection: model.ResponseProtection

systemTags

systemTags: object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

timeCreated

timeCreated: Date

The time the WebAppFirewallPolicy was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time the WebAppFirewallPolicy was updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj