SecurityRuleSummary

class oci.network_firewall.models.SecurityRuleSummary(**kwargs)

Bases: object

Summary for the Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.

Attributes:

ACTION_ALLOW

A constant which can be used with the action property of a SecurityRuleSummary.

ACTION_DROP

A constant which can be used with the action property of a SecurityRuleSummary.

ACTION_INSPECT

A constant which can be used with the action property of a SecurityRuleSummary.

ACTION_REJECT

A constant which can be used with the action property of a SecurityRuleSummary.

INSPECTION_INTRUSION_DETECTION

A constant which can be used with the inspection property of a SecurityRuleSummary.

INSPECTION_INTRUSION_PREVENTION

A constant which can be used with the inspection property of a SecurityRuleSummary.

action

[Required] Gets the action of this SecurityRuleSummary.

description

Gets the description of this SecurityRuleSummary.

inspection

Gets the inspection of this SecurityRuleSummary.

name

[Required] Gets the name of this SecurityRuleSummary.

parent_resource_id

[Required] Gets the parent_resource_id of this SecurityRuleSummary.

priority_order

[Required] Gets the priority_order of this SecurityRuleSummary.

Methods:

__init__(**kwargs)

Initializes a new SecurityRuleSummary object with values from keyword arguments.

ACTION_ALLOW = 'ALLOW'

A constant which can be used with the action property of a SecurityRuleSummary. This constant has a value of “ALLOW”

ACTION_DROP = 'DROP'

A constant which can be used with the action property of a SecurityRuleSummary. This constant has a value of “DROP”

ACTION_INSPECT = 'INSPECT'

A constant which can be used with the action property of a SecurityRuleSummary. This constant has a value of “INSPECT”

ACTION_REJECT = 'REJECT'

A constant which can be used with the action property of a SecurityRuleSummary. This constant has a value of “REJECT”

INSPECTION_INTRUSION_DETECTION = 'INTRUSION_DETECTION'

A constant which can be used with the inspection property of a SecurityRuleSummary. This constant has a value of “INTRUSION_DETECTION”

INSPECTION_INTRUSION_PREVENTION = 'INTRUSION_PREVENTION'

A constant which can be used with the inspection property of a SecurityRuleSummary. This constant has a value of “INTRUSION_PREVENTION”

__init__(**kwargs)

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

Parameters
  • name (str) – The value to assign to the name property of this SecurityRuleSummary.

  • action (str) – The value to assign to the action property of this SecurityRuleSummary. Allowed values for this property are: “ALLOW”, “DROP”, “REJECT”, “INSPECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • inspection (str) – The value to assign to the inspection property of this SecurityRuleSummary. Allowed values for this property are: “INTRUSION_DETECTION”, “INTRUSION_PREVENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • priority_order (int) – The value to assign to the priority_order property of this SecurityRuleSummary.

  • parent_resource_id (str) – The value to assign to the parent_resource_id property of this SecurityRuleSummary.

  • description (str) – The value to assign to the description property of this SecurityRuleSummary.

property action

[Required] Gets the action of this SecurityRuleSummary. Types of Action on the Traffic flow.

  • ALLOW - Allows the traffic.

  • DROP - Silently drops the traffic, e.g. without sending a TCP reset.

  • REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.

  • INSPECT - Inspects traffic for vulnerability as specified in inspection, which may result in rejection.

Allowed values for this property are: “ALLOW”, “DROP”, “REJECT”, “INSPECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The action of this SecurityRuleSummary.

Return type

str

property description

Gets the description of this SecurityRuleSummary. The description of the security rule. This field can be used to add additional info.

Returns

The description of this SecurityRuleSummary.

Return type

str

property inspection

Gets the inspection of this SecurityRuleSummary. Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.

  • INTRUSION_DETECTION - Intrusion Detection.

  • INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in type.

Allowed values for this property are: “INTRUSION_DETECTION”, “INTRUSION_PREVENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The inspection of this SecurityRuleSummary.

Return type

str

property name

[Required] Gets the name of this SecurityRuleSummary. Name for the Security rule, must be unique within the policy.

Returns

The name of this SecurityRuleSummary.

Return type

str

property parent_resource_id

[Required] Gets the parent_resource_id of this SecurityRuleSummary. OCID of the network firewall policy this security rule belongs to.

Returns

The parent_resource_id of this SecurityRuleSummary.

Return type

str

property priority_order

[Required] Gets the priority_order of this SecurityRuleSummary. The priority order in which this rule should be evaluated.

Returns

The priority_order of this SecurityRuleSummary.

Return type

int