SqlFirewallPolicy

class oci.data_safe.models.SqlFirewallPolicy(**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 SqlFirewallPolicy.

ENFORCEMENT_SCOPE_ENFORCE_CONTEXT

A constant which can be used with the enforcement_scope property of a SqlFirewallPolicy.

ENFORCEMENT_SCOPE_ENFORCE_SQL

A constant which can be used with the enforcement_scope property of a SqlFirewallPolicy.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy.

SQL_LEVEL_ALL_SQL

A constant which can be used with the sql_level property of a SqlFirewallPolicy.

SQL_LEVEL_USER_ISSUED_SQL

A constant which can be used with the sql_level property of a SqlFirewallPolicy.

STATUS_DISABLED

A constant which can be used with the status property of a SqlFirewallPolicy.

STATUS_ENABLED

A constant which can be used with the status property of a SqlFirewallPolicy.

VIOLATION_ACTION_BLOCK

A constant which can be used with the violation_action property of a SqlFirewallPolicy.

VIOLATION_ACTION_OBSERVE

A constant which can be used with the violation_action property of a SqlFirewallPolicy.

VIOLATION_AUDIT_DISABLED

A constant which can be used with the violation_audit property of a SqlFirewallPolicy.

VIOLATION_AUDIT_ENABLED

A constant which can be used with the violation_audit property of a SqlFirewallPolicy.

allowed_client_ips

Gets the allowed_client_ips of this SqlFirewallPolicy.

allowed_client_os_usernames

Gets the allowed_client_os_usernames of this SqlFirewallPolicy.

allowed_client_programs

Gets the allowed_client_programs of this SqlFirewallPolicy.

compartment_id

[Required] Gets the compartment_id of this SqlFirewallPolicy.

db_user_name

[Required] Gets the db_user_name of this SqlFirewallPolicy.

defined_tags

Gets the defined_tags of this SqlFirewallPolicy.

description

Gets the description of this SqlFirewallPolicy.

display_name

[Required] Gets the display_name of this SqlFirewallPolicy.

enforcement_scope

Gets the enforcement_scope of this SqlFirewallPolicy.

freeform_tags

Gets the freeform_tags of this SqlFirewallPolicy.

id

[Required] Gets the id of this SqlFirewallPolicy.

lifecycle_details

Gets the lifecycle_details of this SqlFirewallPolicy.

lifecycle_state

[Required] Gets the lifecycle_state of this SqlFirewallPolicy.

security_policy_id

[Required] Gets the security_policy_id of this SqlFirewallPolicy.

sql_level

Gets the sql_level of this SqlFirewallPolicy.

status

[Required] Gets the status of this SqlFirewallPolicy.

system_tags

Gets the system_tags of this SqlFirewallPolicy.

time_created

[Required] Gets the time_created of this SqlFirewallPolicy.

time_updated

Gets the time_updated of this SqlFirewallPolicy.

violation_action

Gets the violation_action of this SqlFirewallPolicy.

violation_audit

Gets the violation_audit of this SqlFirewallPolicy.

Methods:

__init__(**kwargs)

Initializes a new SqlFirewallPolicy 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. This constant has a value of “USER_ISSUED_SQL”

STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a SqlFirewallPolicy. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'

A constant which can be used with the status property of a SqlFirewallPolicy. This constant has a value of “ENABLED”

VIOLATION_ACTION_BLOCK = 'BLOCK'

A constant which can be used with the violation_action property of a SqlFirewallPolicy. This constant has a value of “BLOCK”

VIOLATION_ACTION_OBSERVE = 'OBSERVE'

A constant which can be used with the violation_action property of a SqlFirewallPolicy. This constant has a value of “OBSERVE”

VIOLATION_AUDIT_DISABLED = 'DISABLED'

A constant which can be used with the violation_audit property of a SqlFirewallPolicy. This constant has a value of “DISABLED”

VIOLATION_AUDIT_ENABLED = 'ENABLED'

A constant which can be used with the violation_audit property of a SqlFirewallPolicy. This constant has a value of “ENABLED”

__init__(**kwargs)

Initializes a new SqlFirewallPolicy 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 SqlFirewallPolicy.

  • compartment_id (str) – The value to assign to the compartment_id property of this SqlFirewallPolicy.

  • display_name (str) – The value to assign to the display_name property of this SqlFirewallPolicy.

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

  • security_policy_id (str) – The value to assign to the security_policy_id property of this SqlFirewallPolicy.

  • db_user_name (str) – The value to assign to the db_user_name property of this SqlFirewallPolicy.

  • sql_level (str) – The value to assign to the sql_level property of this SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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 SqlFirewallPolicy. 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’.

  • allowed_client_ips (list[str]) – The value to assign to the allowed_client_ips property of this SqlFirewallPolicy.

  • allowed_client_os_usernames (list[str]) – The value to assign to the allowed_client_os_usernames property of this SqlFirewallPolicy.

  • allowed_client_programs (list[str]) – The value to assign to the allowed_client_programs property of this SqlFirewallPolicy.

  • time_created (datetime) – The value to assign to the time_created property of this SqlFirewallPolicy.

  • time_updated (datetime) – The value to assign to the time_updated property of this SqlFirewallPolicy.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SqlFirewallPolicy.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SqlFirewallPolicy.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SqlFirewallPolicy.

property allowed_client_ips

Gets the allowed_client_ips of this SqlFirewallPolicy. The list of allowed ip addresses for the SQL Firewall policy.

Returns

The allowed_client_ips of this SqlFirewallPolicy.

Return type

list[str]

property allowed_client_os_usernames

Gets the allowed_client_os_usernames of this SqlFirewallPolicy. The list of allowed operating system user names for the SQL Firewall policy.

Returns

The allowed_client_os_usernames of this SqlFirewallPolicy.

Return type

list[str]

property allowed_client_programs

Gets the allowed_client_programs of this SqlFirewallPolicy. The list of allowed client programs for the SQL Firewall policy.

Returns

The allowed_client_programs of this SqlFirewallPolicy.

Return type

list[str]

property compartment_id

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

Returns

The compartment_id of this SqlFirewallPolicy.

Return type

str

property db_user_name

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

Returns

The db_user_name of this SqlFirewallPolicy.

Return type

str

property defined_tags

Gets the defined_tags of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this SqlFirewallPolicy.

Return type

str

property display_name

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

Returns

The display_name of this SqlFirewallPolicy.

Return type

str

property enforcement_scope

Gets the enforcement_scope of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

str

property freeform_tags

Gets the freeform_tags of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

dict(str, str)

property id

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

Returns

The id of this SqlFirewallPolicy.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this SqlFirewallPolicy.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

str

property security_policy_id

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

Returns

The security_policy_id of this SqlFirewallPolicy.

Return type

str

property sql_level

Gets the sql_level of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

str

property status

[Required] Gets the status of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

str

property system_tags

Gets the system_tags of this SqlFirewallPolicy. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this SqlFirewallPolicy.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this SqlFirewallPolicy.

Return type

datetime

property time_updated

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

Returns

The time_updated of this SqlFirewallPolicy.

Return type

datetime

property violation_action

Gets the violation_action of this SqlFirewallPolicy. Specifies the mode in which the SQL Firewall policy is enabled.

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 SqlFirewallPolicy.

Return type

str

property violation_audit

Gets the violation_audit of this SqlFirewallPolicy. 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 SqlFirewallPolicy.

Return type

str