UnifiedAuditPolicy

class oci.data_safe.models.UnifiedAuditPolicy(**kwargs)

Bases: object

Resource represents a single unified audit policy on the target database.

Attributes:

ENABLED_ENTITIES_ALL_USERS

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

ENABLED_ENTITIES_DISABLED

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

ENABLED_ENTITIES_EXCLUDE_USERS

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

ENABLED_ENTITIES_INCLUDE_ROLES

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

ENABLED_ENTITIES_INCLUDE_USERS

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

ENABLED_ENTITIES_INCLUDE_USERS_ROLES

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_UPDATING

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

STATUS_DISABLED

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

STATUS_ENABLED

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

compartment_id

[Required] Gets the compartment_id of this UnifiedAuditPolicy.

conditions

Gets the conditions of this UnifiedAuditPolicy.

defined_tags

Gets the defined_tags of this UnifiedAuditPolicy.

description

Gets the description of this UnifiedAuditPolicy.

display_name

[Required] Gets the display_name of this UnifiedAuditPolicy.

enabled_entities

Gets the enabled_entities of this UnifiedAuditPolicy.

freeform_tags

Gets the freeform_tags of this UnifiedAuditPolicy.

id

[Required] Gets the id of this UnifiedAuditPolicy.

is_seeded

Gets the is_seeded of this UnifiedAuditPolicy.

lifecycle_details

Gets the lifecycle_details of this UnifiedAuditPolicy.

lifecycle_state

[Required] Gets the lifecycle_state of this UnifiedAuditPolicy.

security_policy_id

Gets the security_policy_id of this UnifiedAuditPolicy.

status

Gets the status of this UnifiedAuditPolicy.

system_tags

Gets the system_tags of this UnifiedAuditPolicy.

time_created

[Required] Gets the time_created of this UnifiedAuditPolicy.

time_updated

Gets the time_updated of this UnifiedAuditPolicy.

unified_audit_policy_definition_id

Gets the unified_audit_policy_definition_id of this UnifiedAuditPolicy.

Methods:

__init__(**kwargs)

Initializes a new UnifiedAuditPolicy object with values from keyword arguments.

ENABLED_ENTITIES_ALL_USERS = 'ALL_USERS'

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy. This constant has a value of “ALL_USERS”

ENABLED_ENTITIES_DISABLED = 'DISABLED'

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

ENABLED_ENTITIES_EXCLUDE_USERS = 'EXCLUDE_USERS'

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy. This constant has a value of “EXCLUDE_USERS”

ENABLED_ENTITIES_INCLUDE_ROLES = 'INCLUDE_ROLES'

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy. This constant has a value of “INCLUDE_ROLES”

ENABLED_ENTITIES_INCLUDE_USERS = 'INCLUDE_USERS'

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy. This constant has a value of “INCLUDE_USERS”

ENABLED_ENTITIES_INCLUDE_USERS_ROLES = 'INCLUDE_USERS_ROLES'

A constant which can be used with the enabled_entities property of a UnifiedAuditPolicy. This constant has a value of “INCLUDE_USERS_ROLES”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

STATUS_DISABLED = 'DISABLED'

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

STATUS_ENABLED = 'ENABLED'

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

__init__(**kwargs)

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

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

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

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

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

  • unified_audit_policy_definition_id (str) – The value to assign to the unified_audit_policy_definition_id property of this UnifiedAuditPolicy.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this UnifiedAuditPolicy. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “FAILED”, “DELETING”, “NEEDS_ATTENTION”, “DELETED”, ‘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 UnifiedAuditPolicy.

  • is_seeded (bool) – The value to assign to the is_seeded property of this UnifiedAuditPolicy.

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

  • enabled_entities (str) – The value to assign to the enabled_entities property of this UnifiedAuditPolicy. Allowed values for this property are: “ALL_USERS”, “INCLUDE_USERS”, “INCLUDE_ROLES”, “EXCLUDE_USERS”, “INCLUDE_USERS_ROLES”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • conditions (list[oci.data_safe.models.PolicyCondition]) – The value to assign to the conditions property of this UnifiedAuditPolicy.

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

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

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

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

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

property compartment_id

[Required] Gets the compartment_id of this UnifiedAuditPolicy. The OCID of the compartment containing the unified audit policy.

Returns

The compartment_id of this UnifiedAuditPolicy.

Return type

str

property conditions

Gets the conditions of this UnifiedAuditPolicy. Lists the audit policy provisioning conditions.

Returns

The conditions of this UnifiedAuditPolicy.

Return type

list[oci.data_safe.models.PolicyCondition]

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this UnifiedAuditPolicy. The description of the unified audit policy.

Returns

The description of this UnifiedAuditPolicy.

Return type

str

property display_name

[Required] Gets the display_name of this UnifiedAuditPolicy. The display name of the unified audit policy.

Returns

The display_name of this UnifiedAuditPolicy.

Return type

str

property enabled_entities

Gets the enabled_entities of this UnifiedAuditPolicy. Indicates on whom the audit policy is enabled.

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

Returns

The enabled_entities of this UnifiedAuditPolicy.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this UnifiedAuditPolicy. The OCID of the unified audit policy.

Returns

The id of this UnifiedAuditPolicy.

Return type

str

property is_seeded

Gets the is_seeded of this UnifiedAuditPolicy. Indicates whether the unified audit policy is seeded or not.

Returns

The is_seeded of this UnifiedAuditPolicy.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this UnifiedAuditPolicy. The details of the current state of the unified audit policy in Data Safe.

Returns

The lifecycle_details of this UnifiedAuditPolicy.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this UnifiedAuditPolicy. The current state of the unified audit policy.

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

Returns

The lifecycle_state of this UnifiedAuditPolicy.

Return type

str

property security_policy_id

Gets the security_policy_id of this UnifiedAuditPolicy. The OCID of the security policy corresponding to the unified audit policy.

Returns

The security_policy_id of this UnifiedAuditPolicy.

Return type

str

property status

Gets the status of this UnifiedAuditPolicy. Indicates whether the policy has been 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 UnifiedAuditPolicy.

Return type

str

property system_tags

Gets the system_tags of this UnifiedAuditPolicy. 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 UnifiedAuditPolicy.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this UnifiedAuditPolicy. The time the the unified audit policy was created, in the format defined by RFC3339.

Returns

The time_created of this UnifiedAuditPolicy.

Return type

datetime

property time_updated

Gets the time_updated of this UnifiedAuditPolicy. The last date and time the unified audit policy was updated, in the format defined by RFC3339.

Returns

The time_updated of this UnifiedAuditPolicy.

Return type

datetime

property unified_audit_policy_definition_id

Gets the unified_audit_policy_definition_id of this UnifiedAuditPolicy. The OCID of the associated unified audit policy definition.

Returns

The unified_audit_policy_definition_id of this UnifiedAuditPolicy.

Return type

str