DataMaskRule

class oci.cloud_guard.models.DataMaskRule(**kwargs)

Bases: object

Description of DataMaskRule.

Attributes

DATA_MASK_CATEGORIES_ACTOR A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_CATEGORIES_CUSTOM A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_CATEGORIES_FINANCIAL A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_CATEGORIES_LOCATION A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_CATEGORIES_PHI A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_CATEGORIES_PII A constant which can be used with the data_mask_categories property of a DataMaskRule.
DATA_MASK_RULE_STATUS_DISABLED A constant which can be used with the data_mask_rule_status property of a DataMaskRule.
DATA_MASK_RULE_STATUS_ENABLED A constant which can be used with the data_mask_rule_status property of a DataMaskRule.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a DataMaskRule.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a DataMaskRule.
compartment_id [Required] Gets the compartment_id of this DataMaskRule.
data_mask_categories Gets the data_mask_categories of this DataMaskRule.
data_mask_rule_status Gets the data_mask_rule_status of this DataMaskRule.
defined_tags Gets the defined_tags of this DataMaskRule.
description Gets the description of this DataMaskRule.
display_name Gets the display_name of this DataMaskRule.
freeform_tags Gets the freeform_tags of this DataMaskRule.
iam_group_id [Required] Gets the iam_group_id of this DataMaskRule.
id [Required] Gets the id of this DataMaskRule.
lifecycle_state Gets the lifecycle_state of this DataMaskRule.
lifecyle_details Gets the lifecyle_details of this DataMaskRule.
system_tags Gets the system_tags of this DataMaskRule.
target_selected [Required] Gets the target_selected of this DataMaskRule.
time_created Gets the time_created of this DataMaskRule.
time_updated Gets the time_updated of this DataMaskRule.

Methods

__init__(**kwargs) Initializes a new DataMaskRule object with values from keyword arguments.
DATA_MASK_CATEGORIES_ACTOR = 'ACTOR'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “ACTOR”

DATA_MASK_CATEGORIES_CUSTOM = 'CUSTOM'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “CUSTOM”

DATA_MASK_CATEGORIES_FINANCIAL = 'FINANCIAL'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “FINANCIAL”

DATA_MASK_CATEGORIES_LOCATION = 'LOCATION'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “LOCATION”

DATA_MASK_CATEGORIES_PHI = 'PHI'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “PHI”

DATA_MASK_CATEGORIES_PII = 'PII'

A constant which can be used with the data_mask_categories property of a DataMaskRule. This constant has a value of “PII”

DATA_MASK_RULE_STATUS_DISABLED = 'DISABLED'

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

DATA_MASK_RULE_STATUS_ENABLED = 'ENABLED'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DataMaskRule 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 DataMaskRule.
  • display_name (str) – The value to assign to the display_name property of this DataMaskRule.
  • compartment_id (str) – The value to assign to the compartment_id property of this DataMaskRule.
  • description (str) – The value to assign to the description property of this DataMaskRule.
  • iam_group_id (str) – The value to assign to the iam_group_id property of this DataMaskRule.
  • target_selected (oci.cloud_guard.models.TargetSelected) – The value to assign to the target_selected property of this DataMaskRule.
  • data_mask_categories (list[str]) – The value to assign to the data_mask_categories property of this DataMaskRule. Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”, ‘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 DataMaskRule.
  • time_updated (datetime) – The value to assign to the time_updated property of this DataMaskRule.
  • data_mask_rule_status (str) – The value to assign to the data_mask_rule_status property of this DataMaskRule. 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’.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataMaskRule. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • lifecyle_details (str) – The value to assign to the lifecyle_details property of this DataMaskRule.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DataMaskRule.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DataMaskRule.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DataMaskRule.
compartment_id

[Required] Gets the compartment_id of this DataMaskRule. Compartment Identifier where the resource is created

Returns:The compartment_id of this DataMaskRule.
Return type:str
data_mask_categories

Gets the data_mask_categories of this DataMaskRule. Data Mask Categories

Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The data_mask_categories of this DataMaskRule.
Return type:list[str]
data_mask_rule_status

Gets the data_mask_rule_status of this DataMaskRule. The status of the dataMaskRule.

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 data_mask_rule_status of this DataMaskRule.
Return type:str
defined_tags

Gets the defined_tags of this DataMaskRule. 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 DataMaskRule.
Return type:dict(str, dict(str, object))
description

Gets the description of this DataMaskRule. The data mask rule description.

Returns:The description of this DataMaskRule.
Return type:str
display_name

Gets the display_name of this DataMaskRule. Data Mask Rule Identifier, can be renamed

Returns:The display_name of this DataMaskRule.
Return type:str
freeform_tags

Gets the freeform_tags of this DataMaskRule. 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 DataMaskRule.
Return type:dict(str, str)
iam_group_id

[Required] Gets the iam_group_id of this DataMaskRule. IAM Group id associated with the data mask rule

Returns:The iam_group_id of this DataMaskRule.
Return type:str
id

[Required] Gets the id of this DataMaskRule. Unique identifier that is immutable on creation

Returns:The id of this DataMaskRule.
Return type:str
lifecycle_state

Gets the lifecycle_state of this DataMaskRule. The current state of the DataMaskRule.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 DataMaskRule.
Return type:str
lifecyle_details

Gets the lifecyle_details of this DataMaskRule. 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 lifecyle_details of this DataMaskRule.
Return type:str
system_tags

Gets the system_tags of this DataMaskRule. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

[Required] Gets the target_selected of this DataMaskRule.

Returns:The target_selected of this DataMaskRule.
Return type:oci.cloud_guard.models.TargetSelected
time_created

Gets the time_created of this DataMaskRule. The date and time the target was created. Format defined by RFC3339.

Returns:The time_created of this DataMaskRule.
Return type:datetime
time_updated

Gets the time_updated of this DataMaskRule. The date and time the target was updated. Format defined by RFC3339.

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