CreateDetectorRecipeDetails¶

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

Bases: object

Parameters to use to create details for a detector recipe.

Attributes

`DETECTOR_IAAS_ACTIVITY_DETECTOR`	A constant which can be used with the detector property of a CreateDetectorRecipeDetails.
`DETECTOR_IAAS_CONFIGURATION_DETECTOR`	A constant which can be used with the detector property of a CreateDetectorRecipeDetails.
`DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR`	A constant which can be used with the detector property of a CreateDetectorRecipeDetails.
`DETECTOR_IAAS_LOG_INSIGHT_DETECTOR`	A constant which can be used with the detector property of a CreateDetectorRecipeDetails.
`DETECTOR_IAAS_THREAT_DETECTOR`	A constant which can be used with the detector property of a CreateDetectorRecipeDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDetectorRecipeDetails.
`defined_tags`	Gets the defined_tags of this CreateDetectorRecipeDetails.
`description`	Gets the description of this CreateDetectorRecipeDetails.
`detector`	Gets the detector of this CreateDetectorRecipeDetails.
`detector_rules`	Gets the detector_rules of this CreateDetectorRecipeDetails.
`display_name`	[Required] Gets the display_name of this CreateDetectorRecipeDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDetectorRecipeDetails.
`source_detector_recipe_id`	Gets the source_detector_recipe_id of this CreateDetectorRecipeDetails.

Methods

__init__(**kwargs) Initializes a new CreateDetectorRecipeDetails 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 CreateDetectorRecipeDetails. 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 CreateDetectorRecipeDetails. 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 CreateDetectorRecipeDetails. 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 CreateDetectorRecipeDetails. 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 CreateDetectorRecipeDetails. This constant has a value of “IAAS_THREAT_DETECTOR”

__init__(**kwargs)¶

Initializes a new CreateDetectorRecipeDetails 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 CreateDetectorRecipeDetails.
description (str) – The value to assign to the description property of this CreateDetectorRecipeDetails.
detector (str) – The value to assign to the detector property of this CreateDetectorRecipeDetails. Allowed values for this property are: “IAAS_ACTIVITY_DETECTOR”, “IAAS_CONFIGURATION_DETECTOR”, “IAAS_THREAT_DETECTOR”, “IAAS_LOG_INSIGHT_DETECTOR”, “IAAS_INSTANCE_SECURITY_DETECTOR”
source_detector_recipe_id (str) – The value to assign to the source_detector_recipe_id property of this CreateDetectorRecipeDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDetectorRecipeDetails.
detector_rules (list[oci.cloud_guard.models.UpdateDetectorRecipeDetectorRule]) – The value to assign to the detector_rules property of this CreateDetectorRecipeDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDetectorRecipeDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDetectorRecipeDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateDetectorRecipeDetails. Compartment OCID

Returns:	The compartment_id of this CreateDetectorRecipeDetails.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this CreateDetectorRecipeDetails. Detector recipe description.

Avoid entering confidential information.

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

detector¶

Gets the detector of this CreateDetectorRecipeDetails. Detector 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”

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

detector_rules¶

Gets the detector_rules of this CreateDetectorRecipeDetails. Detector rules to override from source detector recipe

Returns:	The detector_rules of this CreateDetectorRecipeDetails.
Return type:	list[oci.cloud_guard.models.UpdateDetectorRecipeDetectorRule]

display_name¶

[Required] Gets the display_name of this CreateDetectorRecipeDetails. Detector recipe display name.

Avoid entering confidential information.

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

freeform_tags¶

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

source_detector_recipe_id¶

Gets the source_detector_recipe_id of this CreateDetectorRecipeDetails. The ID of the source detector recipe

Returns:	The source_detector_recipe_id of this CreateDetectorRecipeDetails.
Return type:	str