DetectorRecipe

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

Bases: object

A detector recipe is a collection of rules that can be configured to trigger problems that appear on the Cloud Guard Problems page. A DetectorRecipe resource contains settings for a specific detector recipe, plus a list of the detector rules (DetectorRecipeDetectorRule resources) belonging to the DetectorRecipe resource.

Attributes:

DETECTOR_IAAS_ACTIVITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_IAAS_CONFIGURATION_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_IAAS_CONTAINER_SECURITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_IAAS_LOG_INSIGHT_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_IAAS_THREAT_DETECTOR

A constant which can be used with the detector property of a DetectorRecipe.

DETECTOR_RECIPE_TYPE_BASIC

A constant which can be used with the detector_recipe_type property of a DetectorRecipe.

DETECTOR_RECIPE_TYPE_ENTERPRISE

A constant which can be used with the detector_recipe_type property of a DetectorRecipe.

DETECTOR_RECIPE_TYPE_LIMITED

A constant which can be used with the detector_recipe_type property of a DetectorRecipe.

DETECTOR_RECIPE_TYPE_STANDARD

A constant which can be used with the detector_recipe_type property of a DetectorRecipe.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

OWNER_CUSTOMER

A constant which can be used with the owner property of a DetectorRecipe.

OWNER_ORACLE

A constant which can be used with the owner property of a DetectorRecipe.

compartment_id

[Required] Gets the compartment_id of this DetectorRecipe.

defined_tags

Gets the defined_tags of this DetectorRecipe.

description

Gets the description of this DetectorRecipe.

detector

[Required] Gets the detector of this DetectorRecipe.

detector_recipe_type

Gets the detector_recipe_type of this DetectorRecipe.

detector_rules

Gets the detector_rules of this DetectorRecipe.

display_name

[Required] Gets the display_name of this DetectorRecipe.

effective_detector_rules

Gets the effective_detector_rules of this DetectorRecipe.

freeform_tags

Gets the freeform_tags of this DetectorRecipe.

id

[Required] Gets the id of this DetectorRecipe.

lifecycle_state

Gets the lifecycle_state of this DetectorRecipe.

owner

[Required] Gets the owner of this DetectorRecipe.

source_data_retention

Gets the source_data_retention of this DetectorRecipe.

source_detector_recipe_id

[Required] Gets the source_detector_recipe_id of this DetectorRecipe.

system_tags

Gets the system_tags of this DetectorRecipe.

target_ids

Gets the target_ids of this DetectorRecipe.

time_created

Gets the time_created of this DetectorRecipe.

time_updated

Gets the time_updated of this DetectorRecipe.

Methods:

__init__(**kwargs)

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

OWNER_CUSTOMER = 'CUSTOMER'

A constant which can be used with the owner property of a DetectorRecipe. This constant has a value of “CUSTOMER”

OWNER_ORACLE = 'ORACLE'

A constant which can be used with the owner property of a DetectorRecipe. This constant has a value of “ORACLE”

__init__(**kwargs)

Initializes a new DetectorRecipe 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 DetectorRecipe.

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

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

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

  • source_detector_recipe_id (str) – The value to assign to the source_detector_recipe_id property of this DetectorRecipe.

  • detector_recipe_type (str) – The value to assign to the detector_recipe_type property of this DetectorRecipe. 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’.

  • owner (str) – The value to assign to the owner property of this DetectorRecipe. 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 DetectorRecipe. 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.DetectorRecipeDetectorRule]) – The value to assign to the detector_rules property of this DetectorRecipe.

  • effective_detector_rules (list[oci.cloud_guard.models.DetectorRecipeDetectorRule]) – The value to assign to the effective_detector_rules property of this DetectorRecipe.

  • time_created (datetime) – The value to assign to the time_created property of this DetectorRecipe.

  • time_updated (datetime) – The value to assign to the time_updated property of this DetectorRecipe.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DetectorRecipe. 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’.

  • source_data_retention (int) – The value to assign to the source_data_retention property of this DetectorRecipe.

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

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

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

  • target_ids (list[str]) – The value to assign to the target_ids property of this DetectorRecipe.

property compartment_id

[Required] Gets the compartment_id of this DetectorRecipe. Compartment OCID of detector recipe

Returns

The compartment_id of this DetectorRecipe.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this DetectorRecipe. Detector recipe description

Returns

The description of this DetectorRecipe.

Return type

str

property detector

[Required] Gets the detector of this DetectorRecipe. 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 DetectorRecipe.

Return type

str

property detector_recipe_type

Gets the detector_recipe_type of this DetectorRecipe. 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 DetectorRecipe.

Return type

str

property detector_rules

Gets the detector_rules of this DetectorRecipe. List of detector rules for the detector type for recipe - user input

Returns

The detector_rules of this DetectorRecipe.

Return type

list[oci.cloud_guard.models.DetectorRecipeDetectorRule]

property display_name

[Required] Gets the display_name of this DetectorRecipe. Display name of detector recipe

Returns

The display_name of this DetectorRecipe.

Return type

str

property effective_detector_rules

Gets the effective_detector_rules of this DetectorRecipe. List of effective detector rules for the detector type for recipe after applying defaults

Returns

The effective_detector_rules of this DetectorRecipe.

Return type

list[oci.cloud_guard.models.DetectorRecipeDetectorRule]

property freeform_tags

Gets the freeform_tags of this DetectorRecipe. 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 DetectorRecipe.

Return type

dict(str, str)

property id

[Required] Gets the id of this DetectorRecipe. OCID for detector recipe

Returns

The id of this DetectorRecipe.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this DetectorRecipe. 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 DetectorRecipe.

Return type

str

property owner

[Required] Gets the owner of this DetectorRecipe. Owner of 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 DetectorRecipe.

Return type

str

property source_data_retention

Gets the source_data_retention of this DetectorRecipe. The number of days for which source data is retained

Returns

The source_data_retention of this DetectorRecipe.

Return type

int

property source_detector_recipe_id

[Required] Gets the source_detector_recipe_id of this DetectorRecipe. Recipe OCID of the source recipe to be cloned

Returns

The source_detector_recipe_id of this DetectorRecipe.

Return type

str

property system_tags

Gets the system_tags of this DetectorRecipe. 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 DetectorRecipe.

Return type

dict(str, dict(str, object))

property target_ids

Gets the target_ids of this DetectorRecipe. List of target IDs to which the recipe is attached

Returns

The target_ids of this DetectorRecipe.

Return type

list[str]

property time_created

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

Returns

The time_created of this DetectorRecipe.

Return type

datetime

property time_updated

Gets the time_updated of this DetectorRecipe. The date and time the detector recipe was last updated Format defined by RFC3339.

Returns

The time_updated of this DetectorRecipe.

Return type

datetime