SqlFirewallPolicySummary¶

class oci.data_safe.models.SqlFirewallPolicySummary(**kwargs)¶

Bases: object

The SQL Firewall policy resource contains the firewall policy metadata for a single user.

Attributes

`ENFORCEMENT_SCOPE_ENFORCE_ALL`	A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary.
`ENFORCEMENT_SCOPE_ENFORCE_CONTEXT`	A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary.
`ENFORCEMENT_SCOPE_ENFORCE_SQL`	A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary.
`SQL_LEVEL_ALL_SQL`	A constant which can be used with the sql_level property of a SqlFirewallPolicySummary.
`SQL_LEVEL_USER_ISSUED_SQL`	A constant which can be used with the sql_level property of a SqlFirewallPolicySummary.
`STATUS_DISABLED`	A constant which can be used with the status property of a SqlFirewallPolicySummary.
`STATUS_ENABLED`	A constant which can be used with the status property of a SqlFirewallPolicySummary.
`VIOLATION_ACTION_BLOCK`	A constant which can be used with the violation_action property of a SqlFirewallPolicySummary.
`VIOLATION_ACTION_OBSERVE`	A constant which can be used with the violation_action property of a SqlFirewallPolicySummary.
`VIOLATION_AUDIT_DISABLED`	A constant which can be used with the violation_audit property of a SqlFirewallPolicySummary.
`VIOLATION_AUDIT_ENABLED`	A constant which can be used with the violation_audit property of a SqlFirewallPolicySummary.
`compartment_id`	[Required] Gets the compartment_id of this SqlFirewallPolicySummary.
`db_user_name`	[Required] Gets the db_user_name of this SqlFirewallPolicySummary.
`defined_tags`	Gets the defined_tags of this SqlFirewallPolicySummary.
`description`	Gets the description of this SqlFirewallPolicySummary.
`display_name`	[Required] Gets the display_name of this SqlFirewallPolicySummary.
`enforcement_scope`	Gets the enforcement_scope of this SqlFirewallPolicySummary.
`freeform_tags`	Gets the freeform_tags of this SqlFirewallPolicySummary.
`id`	[Required] Gets the id of this SqlFirewallPolicySummary.
`lifecycle_details`	Gets the lifecycle_details of this SqlFirewallPolicySummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SqlFirewallPolicySummary.
`security_policy_id`	[Required] Gets the security_policy_id of this SqlFirewallPolicySummary.
`sql_level`	Gets the sql_level of this SqlFirewallPolicySummary.
`status`	[Required] Gets the status of this SqlFirewallPolicySummary.
`time_created`	[Required] Gets the time_created of this SqlFirewallPolicySummary.
`time_updated`	Gets the time_updated of this SqlFirewallPolicySummary.
`violation_action`	Gets the violation_action of this SqlFirewallPolicySummary.
`violation_audit`	Gets the violation_audit of this SqlFirewallPolicySummary.

Methods

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

ENFORCEMENT_SCOPE_ENFORCE_ALL = 'ENFORCE_ALL'¶: A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary. This constant has a value of “ENFORCE_ALL”

ENFORCEMENT_SCOPE_ENFORCE_CONTEXT = 'ENFORCE_CONTEXT'¶: A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary. This constant has a value of “ENFORCE_CONTEXT”

ENFORCEMENT_SCOPE_ENFORCE_SQL = 'ENFORCE_SQL'¶: A constant which can be used with the enforcement_scope property of a SqlFirewallPolicySummary. This constant has a value of “ENFORCE_SQL”

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a SqlFirewallPolicySummary. This constant has a value of “NEEDS_ATTENTION”

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

SQL_LEVEL_ALL_SQL = 'ALL_SQL'¶: A constant which can be used with the sql_level property of a SqlFirewallPolicySummary. This constant has a value of “ALL_SQL”

SQL_LEVEL_USER_ISSUED_SQL = 'USER_ISSUED_SQL'¶: A constant which can be used with the sql_level property of a SqlFirewallPolicySummary. This constant has a value of “USER_ISSUED_SQL”

STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the status property of a SqlFirewallPolicySummary. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the status property of a SqlFirewallPolicySummary. This constant has a value of “ENABLED”

VIOLATION_ACTION_BLOCK = 'BLOCK'¶: A constant which can be used with the violation_action property of a SqlFirewallPolicySummary. This constant has a value of “BLOCK”

VIOLATION_ACTION_OBSERVE = 'OBSERVE'¶: A constant which can be used with the violation_action property of a SqlFirewallPolicySummary. This constant has a value of “OBSERVE”

VIOLATION_AUDIT_DISABLED = 'DISABLED'¶: A constant which can be used with the violation_audit property of a SqlFirewallPolicySummary. This constant has a value of “DISABLED”

VIOLATION_AUDIT_ENABLED = 'ENABLED'¶: A constant which can be used with the violation_audit property of a SqlFirewallPolicySummary. This constant has a value of “ENABLED”

__init__(**kwargs)¶

Initializes a new SqlFirewallPolicySummary 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 SqlFirewallPolicySummary.
compartment_id (str) – The value to assign to the compartment_id property of this SqlFirewallPolicySummary.
display_name (str) – The value to assign to the display_name property of this SqlFirewallPolicySummary.
description (str) – The value to assign to the description property of this SqlFirewallPolicySummary.
security_policy_id (str) – The value to assign to the security_policy_id property of this SqlFirewallPolicySummary.
db_user_name (str) – The value to assign to the db_user_name property of this SqlFirewallPolicySummary.
sql_level (str) – The value to assign to the sql_level property of this SqlFirewallPolicySummary. Allowed values for this property are: “USER_ISSUED_SQL”, “ALL_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status (str) – The value to assign to the status property of this SqlFirewallPolicySummary. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
enforcement_scope (str) – The value to assign to the enforcement_scope property of this SqlFirewallPolicySummary. Allowed values for this property are: “ENFORCE_CONTEXT”, “ENFORCE_SQL”, “ENFORCE_ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
violation_action (str) – The value to assign to the violation_action property of this SqlFirewallPolicySummary. Allowed values for this property are: “BLOCK”, “OBSERVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
violation_audit (str) – The value to assign to the violation_audit property of this SqlFirewallPolicySummary. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this SqlFirewallPolicySummary.
time_updated (datetime) – The value to assign to the time_updated property of this SqlFirewallPolicySummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SqlFirewallPolicySummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “FAILED”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, ‘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 SqlFirewallPolicySummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SqlFirewallPolicySummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SqlFirewallPolicySummary.

compartment_id¶

[Required] Gets the compartment_id of this SqlFirewallPolicySummary. The OCID of the compartment containing the SQL Firewall policy.

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

db_user_name¶

[Required] Gets the db_user_name of this SqlFirewallPolicySummary. The database user name.

Returns:	The db_user_name of this SqlFirewallPolicySummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this SqlFirewallPolicySummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {“Operations”: {“CostCenter”: “42”}}

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

description¶

Gets the description of this SqlFirewallPolicySummary. The description of the SQL Firewall policy.

Returns:	The description of this SqlFirewallPolicySummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this SqlFirewallPolicySummary. The display name of the SQL Firewall policy.

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

enforcement_scope¶

Gets the enforcement_scope of this SqlFirewallPolicySummary. Specifies the SQL Firewall policy enforcement option.

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

Returns:	The enforcement_scope of this SqlFirewallPolicySummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this SqlFirewallPolicySummary. 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”}

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

id¶

[Required] Gets the id of this SqlFirewallPolicySummary. The OCID of the SQL Firewall policy.

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

lifecycle_details¶

Gets the lifecycle_details of this SqlFirewallPolicySummary. Details about the current state of the SQL Firewall policy in Data Safe.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this SqlFirewallPolicySummary. The current state of the SQL Firewall policy.

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

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

security_policy_id¶

[Required] Gets the security_policy_id of this SqlFirewallPolicySummary. The OCID of the security policy corresponding to the SQL Firewall policy.

Returns:	The security_policy_id of this SqlFirewallPolicySummary.
Return type:	str

sql_level¶

Gets the sql_level of this SqlFirewallPolicySummary. Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.

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

Returns:	The sql_level of this SqlFirewallPolicySummary.
Return type:	str

status¶

[Required] Gets the status of this SqlFirewallPolicySummary. Specifies whether the SQL Firewall policy is enabled or disabled.

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

Returns:	The status of this SqlFirewallPolicySummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this SqlFirewallPolicySummary. The time that the SQL Firewall policy was created, in the format defined by RFC3339.

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

time_updated¶

Gets the time_updated of this SqlFirewallPolicySummary. The date and time the SQL Firewall policy was last updated, in the format defined by RFC3339.

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

violation_action¶

Gets the violation_action of this SqlFirewallPolicySummary. Specifies the SQL Firewall action based on detection of SQL Firewall violations.

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

Returns:	The violation_action of this SqlFirewallPolicySummary.
Return type:	str

violation_audit¶

Gets the violation_audit of this SqlFirewallPolicySummary. Specifies whether a unified audit policy should be enabled for auditing the SQL Firewall policy violations.

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

Returns:	The violation_audit of this SqlFirewallPolicySummary.
Return type:	str