TargetDetectorRecipe¶
- class oci.cloud_guard.models.TargetDetectorRecipe(**kwargs)¶
Bases:
objectA TargetDetectorRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target.
A TargetDetectorRecipe resource: * Is effectively a copy of a DetectorRecipe resource in which users can make very limited changes if it’s Oracle-managed, and more changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding DetectorRecipe, of which the TargetDetectorRecipe resource is effectively a copy, created when the detector recipe is attached to the target.
Attributes:
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector property of a TargetDetectorRecipe.
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe.
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe.
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe.
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe.
A constant which can be used with the owner property of a TargetDetectorRecipe.
A constant which can be used with the owner property of a TargetDetectorRecipe.
[Required] Gets the compartment_id of this TargetDetectorRecipe.
Gets the description of this TargetDetectorRecipe.
[Required] Gets the detector of this TargetDetectorRecipe.
[Required] Gets the detector_recipe_id of this TargetDetectorRecipe.
Gets the detector_recipe_type of this TargetDetectorRecipe.
Gets the detector_rules of this TargetDetectorRecipe.
[Required] Gets the display_name of this TargetDetectorRecipe.
Gets the effective_detector_rules of this TargetDetectorRecipe.
[Required] Gets the id of this TargetDetectorRecipe.
Gets the lifecycle_state of this TargetDetectorRecipe.
Gets the locks of this TargetDetectorRecipe.
[Required] Gets the owner of this TargetDetectorRecipe.
Gets the source_data_retention of this TargetDetectorRecipe.
Gets the time_created of this TargetDetectorRecipe.
Gets the time_updated of this TargetDetectorRecipe.
Methods:
__init__(**kwargs)Initializes a new TargetDetectorRecipe 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 TargetDetectorRecipe. 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 TargetDetectorRecipe. This constant has a value of “IAAS_CONFIGURATION_DETECTOR”
- DETECTOR_IAAS_CONTAINER_SECURITY_DETECTOR = 'IAAS_CONTAINER_SECURITY_DETECTOR'¶
A constant which can be used with the detector property of a TargetDetectorRecipe. This constant has a value of “IAAS_CONTAINER_SECURITY_DETECTOR”
- DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR = 'IAAS_INSTANCE_SECURITY_DETECTOR'¶
A constant which can be used with the detector property of a TargetDetectorRecipe. 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 TargetDetectorRecipe. 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 TargetDetectorRecipe. This constant has a value of “IAAS_THREAT_DETECTOR”
- DETECTOR_RECIPE_TYPE_BASIC = 'BASIC'¶
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe. This constant has a value of “BASIC”
- DETECTOR_RECIPE_TYPE_ENTERPRISE = 'ENTERPRISE'¶
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe. This constant has a value of “ENTERPRISE”
- DETECTOR_RECIPE_TYPE_LIMITED = 'LIMITED'¶
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe. This constant has a value of “LIMITED”
- DETECTOR_RECIPE_TYPE_STANDARD = 'STANDARD'¶
A constant which can be used with the detector_recipe_type property of a TargetDetectorRecipe. This constant has a value of “STANDARD”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a TargetDetectorRecipe. This constant has a value of “UPDATING”
- OWNER_CUSTOMER = 'CUSTOMER'¶
A constant which can be used with the owner property of a TargetDetectorRecipe. This constant has a value of “CUSTOMER”
- OWNER_ORACLE = 'ORACLE'¶
A constant which can be used with the owner property of a TargetDetectorRecipe. This constant has a value of “ORACLE”
- __init__(**kwargs)¶
Initializes a new TargetDetectorRecipe 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 TargetDetectorRecipe.
display_name (str) – The value to assign to the display_name property of this TargetDetectorRecipe.
description (str) – The value to assign to the description property of this TargetDetectorRecipe.
compartment_id (str) – The value to assign to the compartment_id property of this TargetDetectorRecipe.
detector_recipe_id (str) – The value to assign to the detector_recipe_id property of this TargetDetectorRecipe.
owner (str) – The value to assign to the owner property of this TargetDetectorRecipe. Allowed values for this property are: “CUSTOMER”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
detector (str) – The value to assign to the detector property of this TargetDetectorRecipe. Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, “IAAS_CONTAINER_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
detector_rules (list[oci.cloud_guard.models.TargetDetectorRecipeDetectorRule]) – The value to assign to the detector_rules property of this TargetDetectorRecipe.
effective_detector_rules (list[oci.cloud_guard.models.TargetDetectorRecipeDetectorRule]) – The value to assign to the effective_detector_rules property of this TargetDetectorRecipe.
time_created (datetime) – The value to assign to the time_created property of this TargetDetectorRecipe.
time_updated (datetime) – The value to assign to the time_updated property of this TargetDetectorRecipe.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TargetDetectorRecipe. 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’.
locks (list[oci.cloud_guard.models.ResourceLock]) – The value to assign to the locks property of this TargetDetectorRecipe.
detector_recipe_type (str) – The value to assign to the detector_recipe_type property of this TargetDetectorRecipe. Allowed values for this property are: “LIMITED”, “BASIC”, “STANDARD”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
source_data_retention (int) – The value to assign to the source_data_retention property of this TargetDetectorRecipe.
- property compartment_id¶
[Required] Gets the compartment_id of this TargetDetectorRecipe. Compartment OCID of the detector recipe
- Returns
The compartment_id of this TargetDetectorRecipe.
- Return type
str
- property description¶
Gets the description of this TargetDetectorRecipe. Detector recipe description.
- Returns
The description of this TargetDetectorRecipe.
- Return type
str
- property detector¶
[Required] Gets the detector of this TargetDetectorRecipe. Type of detector
Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”, “IAAS_CONTAINER_SECURITY_DETECTOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The detector of this TargetDetectorRecipe.
- Return type
str
- property detector_recipe_id¶
[Required] Gets the detector_recipe_id of this TargetDetectorRecipe. Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based
- Returns
The detector_recipe_id of this TargetDetectorRecipe.
- Return type
str
- property detector_recipe_type¶
Gets the detector_recipe_type of this TargetDetectorRecipe. Recipe type ( STANDARD, ENTERPRISE )
Allowed values for this property are: “LIMITED”, “BASIC”, “STANDARD”, “ENTERPRISE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The detector_recipe_type of this TargetDetectorRecipe.
- Return type
str
- property detector_rules¶
Gets the detector_rules of this TargetDetectorRecipe. List of detector rules for the detector recipe - user input
- Returns
The detector_rules of this TargetDetectorRecipe.
- Return type
list[oci.cloud_guard.models.TargetDetectorRecipeDetectorRule]
- property display_name¶
[Required] Gets the display_name of this TargetDetectorRecipe. Display name of the detector recipe
- Returns
The display_name of this TargetDetectorRecipe.
- Return type
str
- property effective_detector_rules¶
Gets the effective_detector_rules of this TargetDetectorRecipe. List of currently enabled detector rules for the detector type for recipe after applying defaults
- Returns
The effective_detector_rules of this TargetDetectorRecipe.
- Return type
list[oci.cloud_guard.models.TargetDetectorRecipeDetectorRule]
- property id¶
[Required] Gets the id of this TargetDetectorRecipe. OCID for the detector recipe
- Returns
The id of this TargetDetectorRecipe.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this TargetDetectorRecipe. The current lifecycle state of the resource
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 TargetDetectorRecipe.
- Return type
str
- property locks¶
Gets the locks of this TargetDetectorRecipe. Locks associated with this resource.
- Returns
The locks of this TargetDetectorRecipe.
- Return type
- property owner¶
[Required] Gets the owner of this TargetDetectorRecipe. Owner of the detector recipe
Allowed values for this property are: “CUSTOMER”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The owner of this TargetDetectorRecipe.
- Return type
str
- property source_data_retention¶
Gets the source_data_retention of this TargetDetectorRecipe. The number of days for which source data is retained
- Returns
The source_data_retention of this TargetDetectorRecipe.
- Return type
int
- property time_created¶
Gets the time_created of this TargetDetectorRecipe. The date and time the target detector recipe was created. Format defined by RFC3339.
- Returns
The time_created of this TargetDetectorRecipe.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this TargetDetectorRecipe. The date and time the target detector recipe was last updated. Format defined by RFC3339.
- Returns
The time_updated of this TargetDetectorRecipe.
- Return type
datetime