DetectorRule¶

class oci.cloud_guard.models.DetectorRule(**kwargs)¶

Bases: object

Information for a detector rule (DetectorRule object).

Attributes

`DETECTOR_IAAS_ACTIVITY_DETECTOR`	A constant which can be used with the detector property of a DetectorRule.
`DETECTOR_IAAS_CONFIGURATION_DETECTOR`	A constant which can be used with the detector property of a DetectorRule.
`DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR`	A constant which can be used with the detector property of a DetectorRule.
`DETECTOR_IAAS_LOG_INSIGHT_DETECTOR`	A constant which can be used with the detector property of a DetectorRule.
`DETECTOR_IAAS_THREAT_DETECTOR`	A constant which can be used with the detector property of a DetectorRule.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DetectorRule.
`MANAGED_LIST_TYPES_CIDR_BLOCK`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_CITY`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_COUNTRY`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_FUSION_APPS_PERMISSION`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_FUSION_APPS_ROLE`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_GENERIC`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_GROUPS`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_IPV4_ADDRESS`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_IPV6_ADDRESS`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_REGION`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_RESOURCE_OCID`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_STATE`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_TAGS`	A constant which can be used with the managed_list_types property of a DetectorRule.
`MANAGED_LIST_TYPES_USERS`	A constant which can be used with the managed_list_types property of a DetectorRule.
`candidate_responder_rules`	Gets the candidate_responder_rules of this DetectorRule.
`description`	Gets the description of this DetectorRule.
`detector`	[Required] Gets the detector of this DetectorRule.
`detector_details`	Gets the detector_details of this DetectorRule.
`display_name`	Gets the display_name of this DetectorRule.
`id`	[Required] Gets the id of this DetectorRule.
`lifecycle_details`	Gets the lifecycle_details of this DetectorRule.
`lifecycle_state`	Gets the lifecycle_state of this DetectorRule.
`locks`	Gets the locks of this DetectorRule.
`managed_list_types`	Gets the managed_list_types of this DetectorRule.
`recommendation`	Gets the recommendation of this DetectorRule.
`resource_type`	[Required] Gets the resource_type of this DetectorRule.
`service_type`	[Required] Gets the service_type of this DetectorRule.
`time_created`	Gets the time_created of this DetectorRule.
`time_updated`	Gets the time_updated of this DetectorRule.

Methods

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

DETECTOR_IAAS_ACTIVITY_DETECTOR = 'IAAS_ACTIVITY_DETECTOR'¶: A constant which can be used with the detector property of a DetectorRule. This constant has a value of “IAAS_ACTIVITY_DETECTOR”

DETECTOR_IAAS_CONFIGURATION_DETECTOR = 'IAAS_CONFIGURATION_DETECTOR'¶: A constant which can be used with the detector property of a DetectorRule. This constant has a value of “IAAS_CONFIGURATION_DETECTOR”

DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR = 'IAAS_INSTANCE_SECURITY_DETECTOR'¶: A constant which can be used with the detector property of a DetectorRule. This constant has a value of “IAAS_INSTANCE_SECURITY_DETECTOR”

DETECTOR_IAAS_LOG_INSIGHT_DETECTOR = 'IAAS_LOG_INSIGHT_DETECTOR'¶: A constant which can be used with the detector property of a DetectorRule. This constant has a value of “IAAS_LOG_INSIGHT_DETECTOR”

DETECTOR_IAAS_THREAT_DETECTOR = 'IAAS_THREAT_DETECTOR'¶: A constant which can be used with the detector property of a DetectorRule. This constant has a value of “IAAS_THREAT_DETECTOR”

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

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

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

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

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

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

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

MANAGED_LIST_TYPES_CIDR_BLOCK = 'CIDR_BLOCK'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “CIDR_BLOCK”

MANAGED_LIST_TYPES_CITY = 'CITY'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “CITY”

MANAGED_LIST_TYPES_COUNTRY = 'COUNTRY'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “COUNTRY”

MANAGED_LIST_TYPES_FUSION_APPS_PERMISSION = 'FUSION_APPS_PERMISSION'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “FUSION_APPS_PERMISSION”

MANAGED_LIST_TYPES_FUSION_APPS_ROLE = 'FUSION_APPS_ROLE'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “FUSION_APPS_ROLE”

MANAGED_LIST_TYPES_GENERIC = 'GENERIC'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “GENERIC”

MANAGED_LIST_TYPES_GROUPS = 'GROUPS'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “GROUPS”

MANAGED_LIST_TYPES_IPV4_ADDRESS = 'IPV4ADDRESS'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “IPV4ADDRESS”

MANAGED_LIST_TYPES_IPV6_ADDRESS = 'IPV6ADDRESS'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “IPV6ADDRESS”

MANAGED_LIST_TYPES_REGION = 'REGION'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “REGION”

MANAGED_LIST_TYPES_RESOURCE_OCID = 'RESOURCE_OCID'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “RESOURCE_OCID”

MANAGED_LIST_TYPES_STATE = 'STATE'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “STATE”

MANAGED_LIST_TYPES_TAGS = 'TAGS'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “TAGS”

MANAGED_LIST_TYPES_USERS = 'USERS'¶: A constant which can be used with the managed_list_types property of a DetectorRule. This constant has a value of “USERS”

__init__(**kwargs)¶

Initializes a new DetectorRule 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 DetectorRule.
display_name (str) – The value to assign to the display_name property of this DetectorRule.
description (str) – The value to assign to the description property of this DetectorRule.
recommendation (str) – The value to assign to the recommendation property of this DetectorRule.
detector (str) – The value to assign to the detector property of this DetectorRule. Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
service_type (str) – The value to assign to the service_type property of this DetectorRule.
resource_type (str) – The value to assign to the resource_type property of this DetectorRule.
detector_details (oci.cloud_guard.models.DetectorDetails) – The value to assign to the detector_details property of this DetectorRule.
managed_list_types (list[str]) – The value to assign to the managed_list_types property of this DetectorRule. Allowed values for items in this list are: “CIDR_BLOCK”, “USERS”, “GROUPS”, “IPV4ADDRESS”, “IPV6ADDRESS”, “RESOURCE_OCID”, “REGION”, “COUNTRY”, “STATE”, “CITY”, “TAGS”, “GENERIC”, “FUSION_APPS_ROLE”, “FUSION_APPS_PERMISSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
candidate_responder_rules (list[oci.cloud_guard.models.CandidateResponderRule]) – The value to assign to the candidate_responder_rules property of this DetectorRule.
time_created (datetime) – The value to assign to the time_created property of this DetectorRule.
time_updated (datetime) – The value to assign to the time_updated property of this DetectorRule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DetectorRule. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DetectorRule.
locks (list[oci.cloud_guard.models.ResourceLock]) – The value to assign to the locks property of this DetectorRule.

candidate_responder_rules¶

Gets the candidate_responder_rules of this DetectorRule. List of responder rules that could be used to remediate a problem triggered by this detector rule

Returns:	The candidate_responder_rules of this DetectorRule.
Return type:	list[oci.cloud_guard.models.CandidateResponderRule]

description¶

Gets the description of this DetectorRule. Description for the detector rule

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

detector¶

[Required] Gets the detector of this DetectorRule. Detector recipe for the rule

Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The detector of this DetectorRule.
Return type:	str

detector_details¶

Gets the detector_details of this DetectorRule.

Returns:	The detector_details of this DetectorRule.
Return type:	oci.cloud_guard.models.DetectorDetails

display_name¶

Gets the display_name of this DetectorRule. Display name for the detector rule

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

id¶

[Required] Gets the id of this DetectorRule. The unique identifier of the detector rule

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

lifecycle_details¶

Gets the lifecycle_details of this DetectorRule. 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 lifecycle_details of this DetectorRule.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this DetectorRule. The current state of the detector rule

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 DetectorRule.
Return type:	str

locks¶

Gets the locks of this DetectorRule. Locks associated with this resource.

Returns:	The locks of this DetectorRule.
Return type:	list[oci.cloud_guard.models.ResourceLock]

managed_list_types¶

Gets the managed_list_types of this DetectorRule. List of managed list types related to this rule

Allowed values for items in this list are: “CIDR_BLOCK”, “USERS”, “GROUPS”, “IPV4ADDRESS”, “IPV6ADDRESS”, “RESOURCE_OCID”, “REGION”, “COUNTRY”, “STATE”, “CITY”, “TAGS”, “GENERIC”, “FUSION_APPS_ROLE”, “FUSION_APPS_PERMISSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The managed_list_types of this DetectorRule.
Return type:	list[str]

recommendation¶

Gets the recommendation of this DetectorRule. Recommendation for the detector rule

Returns:	The recommendation of this DetectorRule.
Return type:	str

resource_type¶

[Required] Gets the resource_type of this DetectorRule. Resource type of the configuration to which the rule is applied

Returns:	The resource_type of this DetectorRule.
Return type:	str

service_type¶

[Required] Gets the service_type of this DetectorRule. Service type of the configuration to which the rule is applied

Returns:	The service_type of this DetectorRule.
Return type:	str

time_created¶

Gets the time_created of this DetectorRule. The date and time the detector rule was created. Format defined by RFC3339.

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

time_updated¶

Gets the time_updated of this DetectorRule. The date and time the detector rule was updated. Format defined by RFC3339.

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