1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudGuard
  5. getDetectorRecipes
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.CloudGuard.getDetectorRecipes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Detector Recipes in Oracle Cloud Infrastructure Cloud Guard service.

Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.

The ListDetectorRecipes operation returns only the detector recipes in compartmentId passed. The list does not include any subcompartments of the compartmentId passed.

The parameter accessLevel specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn’t have access to even one of the child compartments. This is valid only when compartmentIdInSubtree is set to true.

The parameter compartmentIdInSubtree applies when you perform ListDetectorRecipes on the compartmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter compartmentIdInSubtree to true and accessLevel to ACCESSIBLE.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDetectorRecipes = oci.CloudGuard.getDetectorRecipes({
    compartmentId: compartmentId,
    accessLevel: detectorRecipeAccessLevel,
    compartmentIdInSubtree: detectorRecipeCompartmentIdInSubtree,
    displayName: detectorRecipeDisplayName,
    resourceMetadataOnly: detectorRecipeResourceMetadataOnly,
    state: detectorRecipeState,
});
Copy
import pulumi
import pulumi_oci as oci

test_detector_recipes = oci.CloudGuard.get_detector_recipes(compartment_id=compartment_id,
    access_level=detector_recipe_access_level,
    compartment_id_in_subtree=detector_recipe_compartment_id_in_subtree,
    display_name=detector_recipe_display_name,
    resource_metadata_only=detector_recipe_resource_metadata_only,
    state=detector_recipe_state)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/cloudguard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudguard.GetDetectorRecipes(ctx, &cloudguard.GetDetectorRecipesArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(detectorRecipeAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(detectorRecipeCompartmentIdInSubtree),
			DisplayName:            pulumi.StringRef(detectorRecipeDisplayName),
			ResourceMetadataOnly:   pulumi.BoolRef(detectorRecipeResourceMetadataOnly),
			State:                  pulumi.StringRef(detectorRecipeState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDetectorRecipes = Oci.CloudGuard.GetDetectorRecipes.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = detectorRecipeAccessLevel,
        CompartmentIdInSubtree = detectorRecipeCompartmentIdInSubtree,
        DisplayName = detectorRecipeDisplayName,
        ResourceMetadataOnly = detectorRecipeResourceMetadataOnly,
        State = detectorRecipeState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudGuard.CloudGuardFunctions;
import com.pulumi.oci.CloudGuard.inputs.GetDetectorRecipesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDetectorRecipes = CloudGuardFunctions.getDetectorRecipes(GetDetectorRecipesArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(detectorRecipeAccessLevel)
            .compartmentIdInSubtree(detectorRecipeCompartmentIdInSubtree)
            .displayName(detectorRecipeDisplayName)
            .resourceMetadataOnly(detectorRecipeResourceMetadataOnly)
            .state(detectorRecipeState)
            .build());

    }
}
Copy
variables:
  testDetectorRecipes:
    fn::invoke:
      function: oci:CloudGuard:getDetectorRecipes
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${detectorRecipeAccessLevel}
        compartmentIdInSubtree: ${detectorRecipeCompartmentIdInSubtree}
        displayName: ${detectorRecipeDisplayName}
        resourceMetadataOnly: ${detectorRecipeResourceMetadataOnly}
        state: ${detectorRecipeState}
Copy

Using getDetectorRecipes

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDetectorRecipes(args: GetDetectorRecipesArgs, opts?: InvokeOptions): Promise<GetDetectorRecipesResult>
function getDetectorRecipesOutput(args: GetDetectorRecipesOutputArgs, opts?: InvokeOptions): Output<GetDetectorRecipesResult>
Copy
def get_detector_recipes(access_level: Optional[str] = None,
                         compartment_id: Optional[str] = None,
                         compartment_id_in_subtree: Optional[bool] = None,
                         display_name: Optional[str] = None,
                         filters: Optional[Sequence[_cloudguard.GetDetectorRecipesFilter]] = None,
                         resource_metadata_only: Optional[bool] = None,
                         state: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDetectorRecipesResult
def get_detector_recipes_output(access_level: Optional[pulumi.Input[str]] = None,
                         compartment_id: Optional[pulumi.Input[str]] = None,
                         compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[_cloudguard.GetDetectorRecipesFilterArgs]]]] = None,
                         resource_metadata_only: Optional[pulumi.Input[bool]] = None,
                         state: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDetectorRecipesResult]
Copy
func GetDetectorRecipes(ctx *Context, args *GetDetectorRecipesArgs, opts ...InvokeOption) (*GetDetectorRecipesResult, error)
func GetDetectorRecipesOutput(ctx *Context, args *GetDetectorRecipesOutputArgs, opts ...InvokeOption) GetDetectorRecipesResultOutput
Copy

> Note: This function is named GetDetectorRecipes in the Go SDK.

public static class GetDetectorRecipes 
{
    public static Task<GetDetectorRecipesResult> InvokeAsync(GetDetectorRecipesArgs args, InvokeOptions? opts = null)
    public static Output<GetDetectorRecipesResult> Invoke(GetDetectorRecipesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDetectorRecipesResult> getDetectorRecipes(GetDetectorRecipesArgs args, InvokeOptions options)
public static Output<GetDetectorRecipesResult> getDetectorRecipes(GetDetectorRecipesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:CloudGuard/getDetectorRecipes:getDetectorRecipes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment in which to list resources.
AccessLevel string
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
CompartmentIdInSubtree bool
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetDetectorRecipesFilter>
ResourceMetadataOnly bool
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
State string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
CompartmentId This property is required. string
The OCID of the compartment in which to list resources.
AccessLevel string
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
CompartmentIdInSubtree bool
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetDetectorRecipesFilter
ResourceMetadataOnly bool
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
State string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
compartmentId This property is required. String
The OCID of the compartment in which to list resources.
accessLevel String
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree Boolean
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetDetectorRecipesFilter>
resourceMetadataOnly Boolean
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
compartmentId This property is required. string
The OCID of the compartment in which to list resources.
accessLevel string
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree boolean
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetDetectorRecipesFilter[]
resourceMetadataOnly boolean
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
compartment_id This property is required. str
The OCID of the compartment in which to list resources.
access_level str
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartment_id_in_subtree bool
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
display_name str
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. Sequence[cloudguard.GetDetectorRecipesFilter]
resource_metadata_only bool
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state str
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
compartmentId This property is required. String
The OCID of the compartment in which to list resources.
accessLevel String
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
compartmentIdInSubtree Boolean
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>
resourceMetadataOnly Boolean
Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned.
state String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

getDetectorRecipes Result

The following output properties are available:

CompartmentId string
Compartment OCID of detector recipe
DetectorRecipeCollections List<GetDetectorRecipesDetectorRecipeCollection>
The list of detector_recipe_collection.
Id string
The provider-assigned unique ID for this managed resource.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string
Display name of the entity
Filters List<GetDetectorRecipesFilter>
ResourceMetadataOnly bool
State string
The current lifecycle state of the resource
CompartmentId string
Compartment OCID of detector recipe
DetectorRecipeCollections []GetDetectorRecipesDetectorRecipeCollection
The list of detector_recipe_collection.
Id string
The provider-assigned unique ID for this managed resource.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string
Display name of the entity
Filters []GetDetectorRecipesFilter
ResourceMetadataOnly bool
State string
The current lifecycle state of the resource
compartmentId String
Compartment OCID of detector recipe
detectorRecipeCollections List<GetDetectorRecipesDetectorRecipeCollection>
The list of detector_recipe_collection.
id String
The provider-assigned unique ID for this managed resource.
accessLevel String
compartmentIdInSubtree Boolean
displayName String
Display name of the entity
filters List<GetDetectorRecipesFilter>
resourceMetadataOnly Boolean
state String
The current lifecycle state of the resource
compartmentId string
Compartment OCID of detector recipe
detectorRecipeCollections GetDetectorRecipesDetectorRecipeCollection[]
The list of detector_recipe_collection.
id string
The provider-assigned unique ID for this managed resource.
accessLevel string
compartmentIdInSubtree boolean
displayName string
Display name of the entity
filters GetDetectorRecipesFilter[]
resourceMetadataOnly boolean
state string
The current lifecycle state of the resource
compartment_id str
Compartment OCID of detector recipe
detector_recipe_collections Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollection]
The list of detector_recipe_collection.
id str
The provider-assigned unique ID for this managed resource.
access_level str
compartment_id_in_subtree bool
display_name str
Display name of the entity
filters Sequence[cloudguard.GetDetectorRecipesFilter]
resource_metadata_only bool
state str
The current lifecycle state of the resource
compartmentId String
Compartment OCID of detector recipe
detectorRecipeCollections List<Property Map>
The list of detector_recipe_collection.
id String
The provider-assigned unique ID for this managed resource.
accessLevel String
compartmentIdInSubtree Boolean
displayName String
Display name of the entity
filters List<Property Map>
resourceMetadataOnly Boolean
state String
The current lifecycle state of the resource

Supporting Types

GetDetectorRecipesDetectorRecipeCollection

items This property is required. List<Property Map>

GetDetectorRecipesDetectorRecipeCollectionItem

CompartmentId This property is required. string
The OCID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
Description for detector recipe detector rule
Detector This property is required. string
Detector recipe for the rule
DetectorRecipeType This property is required. string
Recipe type ( STANDARD, ENTERPRISE )
DetectorRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule>
List of detector rules for the detector type for recipe - user input
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EffectiveDetectorRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule>
List of effective detector rules for the detector type for recipe after applying defaults
FreeformTags This property is required. 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"}
Id This property is required. string
OCID for detector recipe
Owner This property is required. string
Owner of detector recipe
SourceDetectorRecipeId This property is required. string
Recipe OCID of the source recipe to be cloned
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
SystemTags This property is required. Dictionary<string, string>
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"}
TargetIds This property is required. List<string>
List of target IDs to which the recipe is attached
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
CompartmentId This property is required. string
The OCID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
Description for detector recipe detector rule
Detector This property is required. string
Detector recipe for the rule
DetectorRecipeType This property is required. string
Recipe type ( STANDARD, ENTERPRISE )
DetectorRules This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule
List of detector rules for the detector type for recipe - user input
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EffectiveDetectorRules This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule
List of effective detector rules for the detector type for recipe after applying defaults
FreeformTags This property is required. map[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"}
Id This property is required. string
OCID for detector recipe
Owner This property is required. string
Owner of detector recipe
SourceDetectorRecipeId This property is required. string
Recipe OCID of the source recipe to be cloned
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
SystemTags This property is required. map[string]string
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"}
TargetIds This property is required. []string
List of target IDs to which the recipe is attached
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
compartmentId This property is required. String
The OCID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
Description for detector recipe detector rule
detector This property is required. String
Detector recipe for the rule
detectorRecipeType This property is required. String
Recipe type ( STANDARD, ENTERPRISE )
detectorRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule>
List of detector rules for the detector type for recipe - user input
displayName This property is required. String
A filter to return only resources that match the entire display name given.
effectiveDetectorRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule>
List of effective detector rules for the detector type for recipe after applying defaults
freeformTags This property is required. Map<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"}
id This property is required. String
OCID for detector recipe
owner This property is required. String
Owner of detector recipe
sourceDetectorRecipeId This property is required. String
Recipe OCID of the source recipe to be cloned
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags This property is required. Map<String,String>
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"}
targetIds This property is required. List<String>
List of target IDs to which the recipe is attached
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.
compartmentId This property is required. string
The OCID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
Description for detector recipe detector rule
detector This property is required. string
Detector recipe for the rule
detectorRecipeType This property is required. string
Recipe type ( STANDARD, ENTERPRISE )
detectorRules This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule[]
List of detector rules for the detector type for recipe - user input
displayName This property is required. string
A filter to return only resources that match the entire display name given.
effectiveDetectorRules This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule[]
List of effective detector rules for the detector type for recipe after applying defaults
freeformTags This property is required. {[key: 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"}
id This property is required. string
OCID for detector recipe
owner This property is required. string
Owner of detector recipe
sourceDetectorRecipeId This property is required. string
Recipe OCID of the source recipe to be cloned
state This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags This property is required. {[key: string]: string}
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"}
targetIds This property is required. string[]
List of target IDs to which the recipe is attached
timeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
compartment_id This property is required. str
The OCID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
Description for detector recipe detector rule
detector This property is required. str
Detector recipe for the rule
detector_recipe_type This property is required. str
Recipe type ( STANDARD, ENTERPRISE )
detector_rules This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule]
List of detector rules for the detector type for recipe - user input
display_name This property is required. str
A filter to return only resources that match the entire display name given.
effective_detector_rules This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule]
List of effective detector rules for the detector type for recipe after applying defaults
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
OCID for detector recipe
owner This property is required. str
Owner of detector recipe
source_detector_recipe_id This property is required. str
Recipe OCID of the source recipe to be cloned
state This property is required. str
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
system_tags This property is required. Mapping[str, str]
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"}
target_ids This property is required. Sequence[str]
List of target IDs to which the recipe is attached
time_created This property is required. str
The date and time the detector recipe was created Format defined by RFC3339.
time_updated This property is required. str
The date and time the detector recipe was last updated Format defined by RFC3339.
compartmentId This property is required. String
The OCID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
Description for detector recipe detector rule
detector This property is required. String
Detector recipe for the rule
detectorRecipeType This property is required. String
Recipe type ( STANDARD, ENTERPRISE )
detectorRules This property is required. List<Property Map>
List of detector rules for the detector type for recipe - user input
displayName This property is required. String
A filter to return only resources that match the entire display name given.
effectiveDetectorRules This property is required. List<Property Map>
List of effective detector rules for the detector type for recipe after applying defaults
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
OCID for detector recipe
owner This property is required. String
Owner of detector recipe
sourceDetectorRecipeId This property is required. String
Recipe OCID of the source recipe to be cloned
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
systemTags This property is required. Map<String>
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"}
targetIds This property is required. List<String>
List of target IDs to which the recipe is attached
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule

CandidateResponderRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule>
List of responder rules that can be used to remediate this detector rule
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
Details This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail>
Detailed information for a detector.
Detector This property is required. string
Detector recipe for the rule
DetectorRuleId This property is required. string
The unique identifier of the detector rule.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping>
Data source entities mapping for the detector rule
LifecycleDetails This property is required. 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.
ManagedListTypes This property is required. List<string>
List of managed list types related to this rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
ResourceType This property is required. string
Resource type of the configuration to which the rule is applied
ServiceType This property is required. string
Service type of the configuration to which the rule is applied
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
CandidateResponderRules This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule
List of responder rules that can be used to remediate this detector rule
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
Details This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail
Detailed information for a detector.
Detector This property is required. string
Detector recipe for the rule
DetectorRuleId This property is required. string
The unique identifier of the detector rule.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntitiesMappings This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping
Data source entities mapping for the detector rule
LifecycleDetails This property is required. 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.
ManagedListTypes This property is required. []string
List of managed list types related to this rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
ResourceType This property is required. string
Resource type of the configuration to which the rule is applied
ServiceType This property is required. string
Service type of the configuration to which the rule is applied
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule>
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
details This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail>
Detailed information for a detector.
detector This property is required. String
Detector recipe for the rule
detectorRuleId This property is required. String
The unique identifier of the detector rule.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping>
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. List<String>
List of managed list types related to this rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. String
Resource type of the configuration to which the rule is applied
serviceType This property is required. String
Service type of the configuration to which the rule is applied
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule[]
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. string
The ID of the attached data source
description This property is required. string
Description for detector recipe detector rule
details This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail[]
Detailed information for a detector.
detector This property is required. string
Detector recipe for the rule
detectorRuleId This property is required. string
The unique identifier of the detector rule.
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping[]
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. string[]
List of managed list types related to this rule
recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. string
Resource type of the configuration to which the rule is applied
serviceType This property is required. string
Service type of the configuration to which the rule is applied
state This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
candidate_responder_rules This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule]
List of responder rules that can be used to remediate this detector rule
data_source_id This property is required. str
The ID of the attached data source
description This property is required. str
Description for detector recipe detector rule
details This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail]
Detailed information for a detector.
detector This property is required. str
Detector recipe for the rule
detector_rule_id This property is required. str
The unique identifier of the detector rule.
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entities_mappings This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping]
Data source entities mapping for the detector rule
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managed_list_types This property is required. Sequence[str]
List of managed list types related to this rule
recommendation This property is required. str
Recommendation for DetectorRecipeDetectorRule resource
resource_type This property is required. str
Resource type of the configuration to which the rule is applied
service_type This property is required. str
Service type of the configuration to which the rule is applied
state This property is required. str
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
time_created This property is required. str
The date and time the detector recipe was created Format defined by RFC3339.
time_updated This property is required. str
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. List<Property Map>
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
details This property is required. List<Property Map>
Detailed information for a detector.
detector This property is required. String
Detector recipe for the rule
detectorRuleId This property is required. String
The unique identifier of the detector rule.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. List<Property Map>
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. List<String>
List of managed list types related to this rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. String
Resource type of the configuration to which the rule is applied
serviceType This property is required. String
Service type of the configuration to which the rule is applied
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
Id This property is required. string
OCID for detector recipe
IsPreferred This property is required. bool
Is this the preferred state?
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
Id This property is required. string
OCID for detector recipe
IsPreferred This property is required. bool
Is this the preferred state?
displayName This property is required. String
A filter to return only resources that match the entire display name given.
id This property is required. String
OCID for detector recipe
isPreferred This property is required. Boolean
Is this the preferred state?
displayName This property is required. string
A filter to return only resources that match the entire display name given.
id This property is required. string
OCID for detector recipe
isPreferred This property is required. boolean
Is this the preferred state?
display_name This property is required. str
A filter to return only resources that match the entire display name given.
id This property is required. str
OCID for detector recipe
is_preferred This property is required. bool
Is this the preferred state?
displayName This property is required. String
A filter to return only resources that match the entire display name given.
id This property is required. String
OCID for detector recipe
isPreferred This property is required. Boolean
Is this the preferred state?

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail

Condition This property is required. string
The base condition resource.
Configurations This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration>
List of detector rule configurations
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
EntitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping>
Data source entities mapping for the detector rule
IsConfigurationAllowed This property is required. bool
Can the rule be configured?
IsEnabled This property is required. bool
Enablement status for the rule
Labels This property is required. List<string>
User-defined labels for a detector rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
RiskLevel This property is required. string
The risk level for the rule
Condition This property is required. string
The base condition resource.
Configurations This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration
List of detector rule configurations
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
EntitiesMappings This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping
Data source entities mapping for the detector rule
IsConfigurationAllowed This property is required. bool
Can the rule be configured?
IsEnabled This property is required. bool
Enablement status for the rule
Labels This property is required. []string
User-defined labels for a detector rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
RiskLevel This property is required. string
The risk level for the rule
condition This property is required. String
The base condition resource.
configurations This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration>
List of detector rule configurations
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
entitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping>
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. Boolean
Can the rule be configured?
isEnabled This property is required. Boolean
Enablement status for the rule
labels This property is required. List<String>
User-defined labels for a detector rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. String
The risk level for the rule
condition This property is required. string
The base condition resource.
configurations This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration[]
List of detector rule configurations
dataSourceId This property is required. string
The ID of the attached data source
description This property is required. string
Description for detector recipe detector rule
entitiesMappings This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping[]
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. boolean
Can the rule be configured?
isEnabled This property is required. boolean
Enablement status for the rule
labels This property is required. string[]
User-defined labels for a detector rule
recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. string
The risk level for the rule
condition This property is required. str
The base condition resource.
configurations This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration]
List of detector rule configurations
data_source_id This property is required. str
The ID of the attached data source
description This property is required. str
Description for detector recipe detector rule
entities_mappings This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping]
Data source entities mapping for the detector rule
is_configuration_allowed This property is required. bool
Can the rule be configured?
is_enabled This property is required. bool
Enablement status for the rule
labels This property is required. Sequence[str]
User-defined labels for a detector rule
recommendation This property is required. str
Recommendation for DetectorRecipeDetectorRule resource
risk_level This property is required. str
The risk level for the rule
condition This property is required. String
The base condition resource.
configurations This property is required. List<Property Map>
List of detector rule configurations
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
entitiesMappings This property is required. List<Property Map>
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. Boolean
Can the rule be configured?
isEnabled This property is required. Boolean
Enablement status for the rule
labels This property is required. List<String>
User-defined labels for a detector rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. String
The risk level for the rule

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration

ConfigKey This property is required. string
Unique identifier of the configuration
DataType This property is required. string
Configuration data type
Name This property is required. string
Configuration name
Value This property is required. string
Configuration value
Values This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue>
List of configuration values
ConfigKey This property is required. string
Unique identifier of the configuration
DataType This property is required. string
Configuration data type
Name This property is required. string
Configuration name
Value This property is required. string
Configuration value
Values This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue
List of configuration values
configKey This property is required. String
Unique identifier of the configuration
dataType This property is required. String
Configuration data type
name This property is required. String
Configuration name
value This property is required. String
Configuration value
values This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue>
List of configuration values
configKey This property is required. string
Unique identifier of the configuration
dataType This property is required. string
Configuration data type
name This property is required. string
Configuration name
value This property is required. string
Configuration value
values This property is required. GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue[]
List of configuration values
config_key This property is required. str
Unique identifier of the configuration
data_type This property is required. str
Configuration data type
name This property is required. str
Configuration name
value This property is required. str
Configuration value
values This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue]
List of configuration values
configKey This property is required. String
Unique identifier of the configuration
dataType This property is required. String
Configuration data type
name This property is required. String
Configuration name
value This property is required. String
Configuration value
values This property is required. List<Property Map>
List of configuration values

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue

ListType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
ManagedListType This property is required. string
Type of content in the managed list
Value This property is required. string
Configuration value
ListType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
ManagedListType This property is required. string
Type of content in the managed list
Value This property is required. string
Configuration value
listType This property is required. String
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. String
Type of content in the managed list
value This property is required. String
Configuration value
listType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. string
Type of content in the managed list
value This property is required. string
Configuration value
list_type This property is required. str
Configuration list item type (CUSTOM or MANAGED)
managed_list_type This property is required. str
Type of content in the managed list
value This property is required. str
Configuration value
listType This property is required. String
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. String
Type of content in the managed list
value This property is required. String
Configuration value

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entityType This property is required. string
Type of entity
queryField This property is required. string
The entity value mapped to a data source query
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entity_type This property is required. str
Type of entity
query_field This property is required. str
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entityType This property is required. string
Type of entity
queryField This property is required. string
The entity value mapped to a data source query
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entity_type This property is required. str
Type of entity
query_field This property is required. str
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule

CandidateResponderRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule>
List of responder rules that can be used to remediate this detector rule
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
Details This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail>
Detailed information for a detector.
Detector This property is required. string
Detector recipe for the rule
DetectorRuleId This property is required. string
The unique identifier of the detector rule.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping>
Data source entities mapping for the detector rule
LifecycleDetails This property is required. 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.
ManagedListTypes This property is required. List<string>
List of managed list types related to this rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
ResourceType This property is required. string
Resource type of the configuration to which the rule is applied
ServiceType This property is required. string
Service type of the configuration to which the rule is applied
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
CandidateResponderRules This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule
List of responder rules that can be used to remediate this detector rule
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
Details This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail
Detailed information for a detector.
Detector This property is required. string
Detector recipe for the rule
DetectorRuleId This property is required. string
The unique identifier of the detector rule.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntitiesMappings This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping
Data source entities mapping for the detector rule
LifecycleDetails This property is required. 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.
ManagedListTypes This property is required. []string
List of managed list types related to this rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
ResourceType This property is required. string
Resource type of the configuration to which the rule is applied
ServiceType This property is required. string
Service type of the configuration to which the rule is applied
State This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
TimeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
TimeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule>
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
details This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail>
Detailed information for a detector.
detector This property is required. String
Detector recipe for the rule
detectorRuleId This property is required. String
The unique identifier of the detector rule.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping>
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. List<String>
List of managed list types related to this rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. String
Resource type of the configuration to which the rule is applied
serviceType This property is required. String
Service type of the configuration to which the rule is applied
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule[]
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. string
The ID of the attached data source
description This property is required. string
Description for detector recipe detector rule
details This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail[]
Detailed information for a detector.
detector This property is required. string
Detector recipe for the rule
detectorRuleId This property is required. string
The unique identifier of the detector rule.
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping[]
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. string[]
List of managed list types related to this rule
recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. string
Resource type of the configuration to which the rule is applied
serviceType This property is required. string
Service type of the configuration to which the rule is applied
state This property is required. string
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. string
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. string
The date and time the detector recipe was last updated Format defined by RFC3339.
candidate_responder_rules This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule]
List of responder rules that can be used to remediate this detector rule
data_source_id This property is required. str
The ID of the attached data source
description This property is required. str
Description for detector recipe detector rule
details This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail]
Detailed information for a detector.
detector This property is required. str
Detector recipe for the rule
detector_rule_id This property is required. str
The unique identifier of the detector rule.
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entities_mappings This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping]
Data source entities mapping for the detector rule
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managed_list_types This property is required. Sequence[str]
List of managed list types related to this rule
recommendation This property is required. str
Recommendation for DetectorRecipeDetectorRule resource
resource_type This property is required. str
Resource type of the configuration to which the rule is applied
service_type This property is required. str
Service type of the configuration to which the rule is applied
state This property is required. str
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
time_created This property is required. str
The date and time the detector recipe was created Format defined by RFC3339.
time_updated This property is required. str
The date and time the detector recipe was last updated Format defined by RFC3339.
candidateResponderRules This property is required. List<Property Map>
List of responder rules that can be used to remediate this detector rule
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
details This property is required. List<Property Map>
Detailed information for a detector.
detector This property is required. String
Detector recipe for the rule
detectorRuleId This property is required. String
The unique identifier of the detector rule.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entitiesMappings This property is required. List<Property Map>
Data source entities mapping for the detector rule
lifecycleDetails This property is required. 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.
managedListTypes This property is required. List<String>
List of managed list types related to this rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
resourceType This property is required. String
Resource type of the configuration to which the rule is applied
serviceType This property is required. String
Service type of the configuration to which the rule is applied
state This property is required. String
The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
timeCreated This property is required. String
The date and time the detector recipe was created Format defined by RFC3339.
timeUpdated This property is required. String
The date and time the detector recipe was last updated Format defined by RFC3339.

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
Id This property is required. string
OCID for detector recipe
IsPreferred This property is required. bool
Is this the preferred state?
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
Id This property is required. string
OCID for detector recipe
IsPreferred This property is required. bool
Is this the preferred state?
displayName This property is required. String
A filter to return only resources that match the entire display name given.
id This property is required. String
OCID for detector recipe
isPreferred This property is required. Boolean
Is this the preferred state?
displayName This property is required. string
A filter to return only resources that match the entire display name given.
id This property is required. string
OCID for detector recipe
isPreferred This property is required. boolean
Is this the preferred state?
display_name This property is required. str
A filter to return only resources that match the entire display name given.
id This property is required. str
OCID for detector recipe
is_preferred This property is required. bool
Is this the preferred state?
displayName This property is required. String
A filter to return only resources that match the entire display name given.
id This property is required. String
OCID for detector recipe
isPreferred This property is required. Boolean
Is this the preferred state?

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail

Condition This property is required. string
The base condition resource.
Configurations This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration>
List of detector rule configurations
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
EntitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping>
Data source entities mapping for the detector rule
IsConfigurationAllowed This property is required. bool
Can the rule be configured?
IsEnabled This property is required. bool
Enablement status for the rule
Labels This property is required. List<string>
User-defined labels for a detector rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
RiskLevel This property is required. string
The risk level for the rule
Condition This property is required. string
The base condition resource.
Configurations This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration
List of detector rule configurations
DataSourceId This property is required. string
The ID of the attached data source
Description This property is required. string
Description for detector recipe detector rule
EntitiesMappings This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping
Data source entities mapping for the detector rule
IsConfigurationAllowed This property is required. bool
Can the rule be configured?
IsEnabled This property is required. bool
Enablement status for the rule
Labels This property is required. []string
User-defined labels for a detector rule
Recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
RiskLevel This property is required. string
The risk level for the rule
condition This property is required. String
The base condition resource.
configurations This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration>
List of detector rule configurations
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
entitiesMappings This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping>
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. Boolean
Can the rule be configured?
isEnabled This property is required. Boolean
Enablement status for the rule
labels This property is required. List<String>
User-defined labels for a detector rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. String
The risk level for the rule
condition This property is required. string
The base condition resource.
configurations This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration[]
List of detector rule configurations
dataSourceId This property is required. string
The ID of the attached data source
description This property is required. string
Description for detector recipe detector rule
entitiesMappings This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping[]
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. boolean
Can the rule be configured?
isEnabled This property is required. boolean
Enablement status for the rule
labels This property is required. string[]
User-defined labels for a detector rule
recommendation This property is required. string
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. string
The risk level for the rule
condition This property is required. str
The base condition resource.
configurations This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration]
List of detector rule configurations
data_source_id This property is required. str
The ID of the attached data source
description This property is required. str
Description for detector recipe detector rule
entities_mappings This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping]
Data source entities mapping for the detector rule
is_configuration_allowed This property is required. bool
Can the rule be configured?
is_enabled This property is required. bool
Enablement status for the rule
labels This property is required. Sequence[str]
User-defined labels for a detector rule
recommendation This property is required. str
Recommendation for DetectorRecipeDetectorRule resource
risk_level This property is required. str
The risk level for the rule
condition This property is required. String
The base condition resource.
configurations This property is required. List<Property Map>
List of detector rule configurations
dataSourceId This property is required. String
The ID of the attached data source
description This property is required. String
Description for detector recipe detector rule
entitiesMappings This property is required. List<Property Map>
Data source entities mapping for the detector rule
isConfigurationAllowed This property is required. Boolean
Can the rule be configured?
isEnabled This property is required. Boolean
Enablement status for the rule
labels This property is required. List<String>
User-defined labels for a detector rule
recommendation This property is required. String
Recommendation for DetectorRecipeDetectorRule resource
riskLevel This property is required. String
The risk level for the rule

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration

ConfigKey This property is required. string
Unique identifier of the configuration
DataType This property is required. string
Configuration data type
Name This property is required. string
Configuration name
Value This property is required. string
Configuration value
Values This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue>
List of configuration values
ConfigKey This property is required. string
Unique identifier of the configuration
DataType This property is required. string
Configuration data type
Name This property is required. string
Configuration name
Value This property is required. string
Configuration value
Values This property is required. []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue
List of configuration values
configKey This property is required. String
Unique identifier of the configuration
dataType This property is required. String
Configuration data type
name This property is required. String
Configuration name
value This property is required. String
Configuration value
values This property is required. List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue>
List of configuration values
configKey This property is required. string
Unique identifier of the configuration
dataType This property is required. string
Configuration data type
name This property is required. string
Configuration name
value This property is required. string
Configuration value
values This property is required. GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue[]
List of configuration values
config_key This property is required. str
Unique identifier of the configuration
data_type This property is required. str
Configuration data type
name This property is required. str
Configuration name
value This property is required. str
Configuration value
values This property is required. Sequence[cloudguard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue]
List of configuration values
configKey This property is required. String
Unique identifier of the configuration
dataType This property is required. String
Configuration data type
name This property is required. String
Configuration name
value This property is required. String
Configuration value
values This property is required. List<Property Map>
List of configuration values

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue

ListType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
ManagedListType This property is required. string
Type of content in the managed list
Value This property is required. string
Configuration value
ListType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
ManagedListType This property is required. string
Type of content in the managed list
Value This property is required. string
Configuration value
listType This property is required. String
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. String
Type of content in the managed list
value This property is required. String
Configuration value
listType This property is required. string
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. string
Type of content in the managed list
value This property is required. string
Configuration value
list_type This property is required. str
Configuration list item type (CUSTOM or MANAGED)
managed_list_type This property is required. str
Type of content in the managed list
value This property is required. str
Configuration value
listType This property is required. String
Configuration list item type (CUSTOM or MANAGED)
managedListType This property is required. String
Type of content in the managed list
value This property is required. String
Configuration value

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entityType This property is required. string
Type of entity
queryField This property is required. string
The entity value mapped to a data source query
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entity_type This property is required. str
Type of entity
query_field This property is required. str
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
EntityType This property is required. string
Type of entity
QueryField This property is required. string
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query
displayName This property is required. string
A filter to return only resources that match the entire display name given.
entityType This property is required. string
Type of entity
queryField This property is required. string
The entity value mapped to a data source query
display_name This property is required. str
A filter to return only resources that match the entire display name given.
entity_type This property is required. str
Type of entity
query_field This property is required. str
The entity value mapped to a data source query
displayName This property is required. String
A filter to return only resources that match the entire display name given.
entityType This property is required. String
Type of entity
queryField This property is required. String
The entity value mapped to a data source query

GetDetectorRecipesFilter

Name This property is required. string
Configuration name
Values This property is required. List<string>
List of configuration values
Regex bool
Name This property is required. string
Configuration name
Values This property is required. []string
List of configuration values
Regex bool
name This property is required. String
Configuration name
values This property is required. List<String>
List of configuration values
regex Boolean
name This property is required. string
Configuration name
values This property is required. string[]
List of configuration values
regex boolean
name This property is required. str
Configuration name
values This property is required. Sequence[str]
List of configuration values
regex bool
name This property is required. String
Configuration name
values This property is required. List<String>
List of configuration values
regex Boolean

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi