Show / Hide Table of Contents

Class 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).
Inheritance
object
ResponderRecipe
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CloudguardService.Models
Assembly: OCI.DotNetSDK.Cloudguard.dll
Syntax
public class ResponderRecipe

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Compartment OCID

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Responder recipe description

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Responder recipe display name

EffectiveResponderRules

Declaration
[JsonProperty(PropertyName = "effectiveResponderRules")]
public List<ResponderRecipeResponderRule> EffectiveResponderRules { get; set; }
Property Value
Type Description
List<ResponderRecipeResponderRule>

List of currently enabled responder rules for the responder type, for recipe after applying defaults

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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.

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Unique identifier for the responder recip

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
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.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current lifecycle state of the example

Owner

Declaration
[JsonProperty(PropertyName = "owner")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OwnerType? Owner { get; set; }
Property Value
Type Description
OwnerType?

Owner of responder recipe

ResponderRules

Declaration
[JsonProperty(PropertyName = "responderRules")]
public List<ResponderRecipeResponderRule> ResponderRules { get; set; }
Property Value
Type Description
List<ResponderRecipeResponderRule>

List of responder rules associated with the recipe

SourceResponderRecipeId

Declaration
[JsonProperty(PropertyName = "sourceResponderRecipeId")]
public string SourceResponderRecipeId { get; set; }
Property Value
Type Description
string

The unique identifier of the source responder recipe

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, 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: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

In this article
Back to top