Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ResponderRecipe

A ResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat).

A ResponderRecipe resource: * Is effectively a copy of a Responder resource in which users can make very limited changes if it\u2019s Oracle-managed, and more changes if it\u2019s user-managed. * Can also be created by cloning an existing ResponderRecipe resource, either user-managed or Oracle-managed. * Is visible on Cloud Guard\u2019s Responder Recipes page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply globally, to resources in all OCI compartments mapped to a target that attaches the responder recipe, but are overridden by any changes made in the corresponding TargetResponderRecipe resource (effectively created when the responder recipe is attached to the target).

Properties

compartmentId

compartmentId: string

Compartment OCID

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

Responder recipe description

Optional displayName

displayName: undefined | string

Responder recipe display name

Optional effectiveResponderRules

effectiveResponderRules: Array<ResponderRecipeResponderRule>

List of currently enabled responder rules for the responder 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

Unique identifier for the responder recip

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current lifecycle state of the example

Optional owner

owner: model.OwnerType

Owner of responder recipe

Optional responderRules

List of responder rules associated with the recipe

Optional sourceResponderRecipeId

sourceResponderRecipeId: undefined | string

The unique identifier of the source responder recipe

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 timeCreated

timeCreated: Date

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

Optional timeUpdated

timeUpdated: Date

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

Functions

getDeserializedJsonObj

getJsonObj