Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DetectorRecipe

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.

Properties

compartmentId

compartmentId: string

Compartment OCID of detector recipe

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

Detector recipe description

detector

detector: DetectorEnum

Type of detector

Optional detectorRecipeType

detectorRecipeType: model.DetectorRecipeEnum

Recipe type ( STANDARD, ENTERPRISE )

Optional detectorRules

List of detector rules for the detector type for recipe - user input

displayName

displayName: string

Display name of detector recipe

Optional effectiveDetectorRules

effectiveDetectorRules: Array<DetectorRecipeDetectorRule>

List of effective detector rules for the detector type for recipe after applying defaults

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Avoid entering confidential information.

id

id: string

OCID for detector recipe

Optional lifecycleState

lifecycleState: model.LifecycleState

The current lifecycle state of the resource

owner

owner: OwnerType

Owner of detector recipe

Optional sourceDataRetention

sourceDataRetention: undefined | number

The number of days for which source data is retained Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

sourceDetectorRecipeId

sourceDetectorRecipeId: string

Recipe OCID of the source recipe to be cloned

Optional systemTags

systemTags: undefined | object

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: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

Optional targetIds

targetIds: Array<string>

List of target IDs to which the recipe is attached

Optional timeCreated

timeCreated: Date

The date and time the detector recipe was created Format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

The date and time the detector recipe was last updated Format defined by RFC3339.

Functions

getDeserializedJsonObj

getJsonObj