WebAppFirewallPolicy¶

class oci.waf.models.WebAppFirewallPolicy(**kwargs)¶

Bases: object

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

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy.
`actions`	Gets the actions of this WebAppFirewallPolicy.
`compartment_id`	[Required] Gets the compartment_id of this WebAppFirewallPolicy.
`defined_tags`	[Required] Gets the defined_tags of this WebAppFirewallPolicy.
`display_name`	[Required] Gets the display_name of this WebAppFirewallPolicy.
`freeform_tags`	[Required] Gets the freeform_tags of this WebAppFirewallPolicy.
`id`	[Required] Gets the id of this WebAppFirewallPolicy.
`lifecycle_details`	Gets the lifecycle_details of this WebAppFirewallPolicy.
`lifecycle_state`	[Required] Gets the lifecycle_state of this WebAppFirewallPolicy.
`request_access_control`	Gets the request_access_control of this WebAppFirewallPolicy.
`request_protection`	Gets the request_protection of this WebAppFirewallPolicy.
`request_rate_limiting`	Gets the request_rate_limiting of this WebAppFirewallPolicy.
`response_access_control`	Gets the response_access_control of this WebAppFirewallPolicy.
`response_protection`	Gets the response_protection of this WebAppFirewallPolicy.
`system_tags`	[Required] Gets the system_tags of this WebAppFirewallPolicy.
`time_created`	[Required] Gets the time_created of this WebAppFirewallPolicy.
`time_updated`	Gets the time_updated of this WebAppFirewallPolicy.

Methods

__init__(**kwargs) Initializes a new WebAppFirewallPolicy object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a WebAppFirewallPolicy. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new WebAppFirewallPolicy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this WebAppFirewallPolicy.
display_name (str) – The value to assign to the display_name property of this WebAppFirewallPolicy.
compartment_id (str) – The value to assign to the compartment_id property of this WebAppFirewallPolicy.
time_created (datetime) – The value to assign to the time_created property of this WebAppFirewallPolicy.
time_updated (datetime) – The value to assign to the time_updated property of this WebAppFirewallPolicy.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this WebAppFirewallPolicy. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this WebAppFirewallPolicy.
actions (list[oci.waf.models.Action]) – The value to assign to the actions property of this WebAppFirewallPolicy.
request_access_control (oci.waf.models.RequestAccessControl) – The value to assign to the request_access_control property of this WebAppFirewallPolicy.
request_rate_limiting (oci.waf.models.RequestRateLimiting) – The value to assign to the request_rate_limiting property of this WebAppFirewallPolicy.
request_protection (oci.waf.models.RequestProtection) – The value to assign to the request_protection property of this WebAppFirewallPolicy.
response_access_control (oci.waf.models.ResponseAccessControl) – The value to assign to the response_access_control property of this WebAppFirewallPolicy.
response_protection (oci.waf.models.ResponseProtection) – The value to assign to the response_protection property of this WebAppFirewallPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this WebAppFirewallPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this WebAppFirewallPolicy.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this WebAppFirewallPolicy.

actions¶

Gets the actions of this WebAppFirewallPolicy. 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.

Returns:	The actions of this WebAppFirewallPolicy.
Return type:	list[oci.waf.models.Action]

compartment_id¶

[Required] Gets the compartment_id of this WebAppFirewallPolicy. The OCID of the compartment.

Returns:	The compartment_id of this WebAppFirewallPolicy.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this WebAppFirewallPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this WebAppFirewallPolicy.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this WebAppFirewallPolicy. WebAppFirewallPolicy display name, can be renamed.

Returns:	The display_name of this WebAppFirewallPolicy.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this WebAppFirewallPolicy. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this WebAppFirewallPolicy.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this WebAppFirewallPolicy. The OCID of the WebAppFirewallPolicy.

Returns:	The id of this WebAppFirewallPolicy.
Return type:	str

lifecycle_details¶

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

Returns:	The lifecycle_details of this WebAppFirewallPolicy.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this WebAppFirewallPolicy. The current state of the WebAppFirewallPolicy.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this WebAppFirewallPolicy.
Return type:	str

request_access_control¶

Gets the request_access_control of this WebAppFirewallPolicy.

Returns:	The request_access_control of this WebAppFirewallPolicy.
Return type:	oci.waf.models.RequestAccessControl

request_protection¶

Gets the request_protection of this WebAppFirewallPolicy.

Returns:	The request_protection of this WebAppFirewallPolicy.
Return type:	oci.waf.models.RequestProtection

request_rate_limiting¶

Gets the request_rate_limiting of this WebAppFirewallPolicy.

Returns:	The request_rate_limiting of this WebAppFirewallPolicy.
Return type:	oci.waf.models.RequestRateLimiting

response_access_control¶

Gets the response_access_control of this WebAppFirewallPolicy.

Returns:	The response_access_control of this WebAppFirewallPolicy.
Return type:	oci.waf.models.ResponseAccessControl

response_protection¶

Gets the response_protection of this WebAppFirewallPolicy.

Returns:	The response_protection of this WebAppFirewallPolicy.
Return type:	oci.waf.models.ResponseProtection

system_tags¶

[Required] Gets the system_tags of this WebAppFirewallPolicy. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this WebAppFirewallPolicy.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this WebAppFirewallPolicy. The time the WebAppFirewallPolicy was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this WebAppFirewallPolicy.
Return type:	datetime

time_updated¶

Gets the time_updated of this WebAppFirewallPolicy. The time the WebAppFirewallPolicy was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this WebAppFirewallPolicy.
Return type:	datetime