CreateDataMaskRuleDetails

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

Bases: object

Parameters to us to create a new data mask rule.

Attributes:

DATA_MASK_CATEGORIES_ACTOR

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_CATEGORIES_CUSTOM

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_CATEGORIES_FINANCIAL

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_CATEGORIES_LOCATION

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_CATEGORIES_PHI

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_CATEGORIES_PII

A constant which can be used with the data_mask_categories property of a CreateDataMaskRuleDetails.

DATA_MASK_RULE_STATUS_DISABLED

A constant which can be used with the data_mask_rule_status property of a CreateDataMaskRuleDetails.

DATA_MASK_RULE_STATUS_ENABLED

A constant which can be used with the data_mask_rule_status property of a CreateDataMaskRuleDetails.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

compartment_id

[Required] Gets the compartment_id of this CreateDataMaskRuleDetails.

data_mask_categories

[Required] Gets the data_mask_categories of this CreateDataMaskRuleDetails.

data_mask_rule_status

Gets the data_mask_rule_status of this CreateDataMaskRuleDetails.

defined_tags

Gets the defined_tags of this CreateDataMaskRuleDetails.

description

Gets the description of this CreateDataMaskRuleDetails.

display_name

[Required] Gets the display_name of this CreateDataMaskRuleDetails.

freeform_tags

Gets the freeform_tags of this CreateDataMaskRuleDetails.

iam_group_id

[Required] Gets the iam_group_id of this CreateDataMaskRuleDetails.

lifecycle_state

Gets the lifecycle_state of this CreateDataMaskRuleDetails.

target_selected

[Required] Gets the target_selected of this CreateDataMaskRuleDetails.

Methods:

__init__(**kwargs)

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

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

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

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

  • iam_group_id (str) – The value to assign to the iam_group_id property of this CreateDataMaskRuleDetails.

  • target_selected (oci.cloud_guard.models.TargetSelected) – The value to assign to the target_selected property of this CreateDataMaskRuleDetails.

  • data_mask_categories (list[str]) – The value to assign to the data_mask_categories property of this CreateDataMaskRuleDetails. Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”

  • data_mask_rule_status (str) – The value to assign to the data_mask_rule_status property of this CreateDataMaskRuleDetails. Allowed values for this property are: “ENABLED”, “DISABLED”

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateDataMaskRuleDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”

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

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

property compartment_id

[Required] Gets the compartment_id of this CreateDataMaskRuleDetails. Compartment OCID where the resource is created

Returns

The compartment_id of this CreateDataMaskRuleDetails.

Return type

str

property data_mask_categories

[Required] Gets the data_mask_categories of this CreateDataMaskRuleDetails. Data mask rule categories

Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”

Returns

The data_mask_categories of this CreateDataMaskRuleDetails.

Return type

list[str]

property data_mask_rule_status

Gets the data_mask_rule_status of this CreateDataMaskRuleDetails. The current status of the data mask rule

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns

The data_mask_rule_status of this CreateDataMaskRuleDetails.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateDataMaskRuleDetails. The data mask rule description Avoid entering confidential information.

Returns

The description of this CreateDataMaskRuleDetails.

Return type

str

property display_name

[Required] Gets the display_name of this CreateDataMaskRuleDetails. Data mask rule display name

Avoid entering confidential information.

Returns

The display_name of this CreateDataMaskRuleDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDataMaskRuleDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information.

Returns

The freeform_tags of this CreateDataMaskRuleDetails.

Return type

dict(str, str)

property iam_group_id

[Required] Gets the iam_group_id of this CreateDataMaskRuleDetails. IAM group ID associated with the data mask rule

Returns

The iam_group_id of this CreateDataMaskRuleDetails.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this CreateDataMaskRuleDetails. The current lifecycle state of the data mask rule

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”

Returns

The lifecycle_state of this CreateDataMaskRuleDetails.

Return type

str

property target_selected

[Required] Gets the target_selected of this CreateDataMaskRuleDetails.

Returns

The target_selected of this CreateDataMaskRuleDetails.

Return type

oci.cloud_guard.models.TargetSelected