Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getDetectorRecipes

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

Returns a list of all Detector Recipes in a compartment

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

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDetectorRecipes = Output.Create(Oci.CloudGuard.GetDetectorRecipes.InvokeAsync(new Oci.CloudGuard.GetDetectorRecipesArgs
        {
            CompartmentId = @var.Compartment_id,
            AccessLevel = @var.Detector_recipe_access_level,
            CompartmentIdInSubtree = @var.Detector_recipe_compartment_id_in_subtree,
            DisplayName = @var.Detector_recipe_display_name,
            ResourceMetadataOnly = @var.Detector_recipe_resource_metadata_only,
            State = @var.Detector_recipe_state,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Detector_recipe_access_level),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Detector_recipe_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Detector_recipe_display_name),
			ResourceMetadataOnly:   pulumi.BoolRef(_var.Detector_recipe_resource_metadata_only),
			State:                  pulumi.StringRef(_var.Detector_recipe_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_detector_recipes = oci.CloudGuard.get_detector_recipes(compartment_id=var["compartment_id"],
    access_level=var["detector_recipe_access_level"],
    compartment_id_in_subtree=var["detector_recipe_compartment_id_in_subtree"],
    display_name=var["detector_recipe_display_name"],
    resource_metadata_only=var["detector_recipe_resource_metadata_only"],
    state=var["detector_recipe_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDetectorRecipes = oci.CloudGuard.getDetectorRecipes({
    compartmentId: _var.compartment_id,
    accessLevel: _var.detector_recipe_access_level,
    compartmentIdInSubtree: _var.detector_recipe_compartment_id_in_subtree,
    displayName: _var.detector_recipe_display_name,
    resourceMetadataOnly: _var.detector_recipe_resource_metadata_only,
    state: _var.detector_recipe_state,
});

Coming soon!

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>
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]
func GetDetectorRecipes(ctx *Context, args *GetDetectorRecipesArgs, opts ...InvokeOption) (*GetDetectorRecipesResult, error)
func GetDetectorRecipesOutput(ctx *Context, args *GetDetectorRecipesOutputArgs, opts ...InvokeOption) GetDetectorRecipesResultOutput

> 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)
}
public static CompletableFuture<GetDetectorRecipesResult> getDetectorRecipes(GetDetectorRecipesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:CloudGuard/getDetectorRecipes:getDetectorRecipes
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The ID 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 the setting of accessLevel.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters List<GetDetectorRecipesFilter>
ResourceMetadataOnly bool

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

CompartmentId string

The ID 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 the setting of accessLevel.

DisplayName string

A filter to return only resources that match the entire display name given.

Filters []GetDetectorRecipesFilter
ResourceMetadataOnly bool

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId String

The ID 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 the setting of accessLevel.

displayName String

A filter to return only resources that match the entire display name given.

filters List<GetDetectorRecipesFilter>
resourceMetadataOnly Boolean

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId string

The ID 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 the setting of accessLevel.

displayName string

A filter to return only resources that match the entire display name given.

filters GetDetectorRecipesFilter[]
resourceMetadataOnly boolean

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

state string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartment_id str

The ID 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 the setting of accessLevel.

display_name str

A filter to return only resources that match the entire display name given.

filters GetDetectorRecipesFilter]
resource_metadata_only bool

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

state str

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

compartmentId String

The ID 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 the setting of accessLevel.

displayName String

A filter to return only resources that match the entire display name given.

filters List<Property Map>
resourceMetadataOnly Boolean

Default is false. When set to true, the list of all Oracle Managed Resources Metadata supported by Cloud Guard are returned.

state String

The field life cycle 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

compartmentId 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

displayName

Filters List<GetDetectorRecipesFilter>
ResourceMetadataOnly bool
State string

The current state of the resource.

CompartmentId string

compartmentId 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

displayName

Filters []GetDetectorRecipesFilter
ResourceMetadataOnly bool
State string

The current state of the resource.

compartmentId String

compartmentId 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

displayName

filters List<GetDetectorRecipesFilter>
resourceMetadataOnly Boolean
state String

The current state of the resource.

compartmentId string

compartmentId 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

displayName

filters GetDetectorRecipesFilter[]
resourceMetadataOnly boolean
state string

The current state of the resource.

compartment_id str

compartmentId of detector recipe

detector_recipe_collections 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

displayName

filters GetDetectorRecipesFilter]
resource_metadata_only bool
state str

The current state of the resource.

compartmentId String

compartmentId 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

displayName

filters List<Property Map>
resourceMetadataOnly Boolean
state String

The current state of the resource.

Supporting Types

GetDetectorRecipesDetectorRecipeCollection

GetDetectorRecipesDetectorRecipeCollectionItem

CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags Dictionary<string, object>

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

Description string

Description for DetectorRecipeDetectorRule

Detector string

detector for the rule

DetectorRules List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule>

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

DisplayName string

A filter to return only resources that match the entire display name given.

EffectiveDetectorRules List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule>

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

FreeformTags Dictionary<string, object>

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

Id string

Ocid for detector recipe

Owner string

Owner of detector recipe

SourceDetectorRecipeId string

Recipe Ocid of the Source Recipe to be cloned

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

SystemTags 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 string

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

TimeUpdated string

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

CompartmentId string

The ID of the compartment in which to list resources.

DefinedTags map[string]interface{}

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

Description string

Description for DetectorRecipeDetectorRule

Detector string

detector for the rule

DetectorRules []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule

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

DisplayName string

A filter to return only resources that match the entire display name given.

EffectiveDetectorRules []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule

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

FreeformTags map[string]interface{}

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

Id string

Ocid for detector recipe

Owner string

Owner of detector recipe

SourceDetectorRecipeId string

Recipe Ocid of the Source Recipe to be cloned

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

SystemTags map[string]interface{}

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 string

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

TimeUpdated string

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

compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<String,Object>

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

description String

Description for DetectorRecipeDetectorRule

detector String

detector for the rule

detectorRules List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule>

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

displayName String

A filter to return only resources that match the entire display name given.

effectiveDetectorRules List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule>

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

freeformTags Map<String,Object>

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

id String

Ocid for detector recipe

owner String

Owner of detector recipe

sourceDetectorRecipeId String

Recipe Ocid of the Source Recipe to be cloned

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

systemTags Map<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 String

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

timeUpdated String

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

compartmentId string

The ID of the compartment in which to list resources.

definedTags {[key: string]: any}

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

description string

Description for DetectorRecipeDetectorRule

detector string

detector for the rule

detectorRules GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule[]

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

displayName string

A filter to return only resources that match the entire display name given.

effectiveDetectorRules GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule[]

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

freeformTags {[key: string]: any}

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

id string

Ocid for detector recipe

owner string

Owner of detector recipe

sourceDetectorRecipeId string

Recipe Ocid of the Source Recipe to be cloned

state string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

systemTags {[key: string]: any}

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 string

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

timeUpdated string

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

compartment_id str

The ID of the compartment in which to list resources.

defined_tags Mapping[str, Any]

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

description str

Description for DetectorRecipeDetectorRule

detector str

detector for the rule

detector_rules GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule]

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

display_name str

A filter to return only resources that match the entire display name given.

effective_detector_rules GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule]

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

freeform_tags Mapping[str, Any]

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

id str

Ocid for detector recipe

owner str

Owner of detector recipe

source_detector_recipe_id str

Recipe Ocid of the Source Recipe to be cloned

state str

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

system_tags Mapping[str, Any]

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"}

time_created str

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

time_updated str

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

compartmentId String

The ID of the compartment in which to list resources.

definedTags Map<Any>

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

description String

Description for DetectorRecipeDetectorRule

detector String

detector for the rule

detectorRules List<Property Map>

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

displayName String

A filter to return only resources that match the entire display name given.

effectiveDetectorRules List<Property Map>

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

freeformTags Map<Any>

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

id String

Ocid for detector recipe

owner String

Owner of detector recipe

sourceDetectorRecipeId String

Recipe Ocid of the Source Recipe to be cloned

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

systemTags Map<Any>

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 String

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

timeUpdated String

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

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule

CandidateResponderRules List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule>

List of CandidateResponderRule related to this rule

Description string

Description for DetectorRecipeDetectorRule

Details List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail>

Details of a Detector Rule

Detector string

detector for the rule

DetectorRuleId string

The unique identifier of the detector rule

DisplayName string

A filter to return only resources that match the entire display name given.

LifecycleDetails 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 List<string>

List of cloudguard managed list types related to this rule

Recommendation string

Recommendation for DetectorRecipeDetectorRule

ResourceType string

resource type of the configuration to which the rule is applied

ServiceType string

service type of the configuration to which the rule is applied

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

TimeCreated string

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

TimeUpdated string

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

CandidateResponderRules []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule

List of CandidateResponderRule related to this rule

Description string

Description for DetectorRecipeDetectorRule

Details []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail

Details of a Detector Rule

Detector string

detector for the rule

DetectorRuleId string

The unique identifier of the detector rule

DisplayName string

A filter to return only resources that match the entire display name given.

LifecycleDetails 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 []string

List of cloudguard managed list types related to this rule

Recommendation string

Recommendation for DetectorRecipeDetectorRule

ResourceType string

resource type of the configuration to which the rule is applied

ServiceType string

service type of the configuration to which the rule is applied

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

TimeCreated string

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

TimeUpdated string

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

candidateResponderRules List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule>

List of CandidateResponderRule related to this rule

description String

Description for DetectorRecipeDetectorRule

details List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail>

Details of a Detector Rule

detector String

detector for the rule

detectorRuleId String

The unique identifier of the detector rule

displayName String

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 List<String>

List of cloudguard managed list types related to this rule

recommendation String

Recommendation for DetectorRecipeDetectorRule

resourceType String

resource type of the configuration to which the rule is applied

serviceType String

service type of the configuration to which the rule is applied

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated String

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

timeUpdated String

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

candidateResponderRules GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule[]

List of CandidateResponderRule related to this rule

description string

Description for DetectorRecipeDetectorRule

details GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail[]

Details of a Detector Rule

detector string

detector for the rule

detectorRuleId string

The unique identifier of the detector rule

displayName string

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 string[]

List of cloudguard managed list types related to this rule

recommendation string

Recommendation for DetectorRecipeDetectorRule

resourceType string

resource type of the configuration to which the rule is applied

serviceType string

service type of the configuration to which the rule is applied

state string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated string

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

timeUpdated string

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

candidate_responder_rules GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule]

List of CandidateResponderRule related to this rule

description str

Description for DetectorRecipeDetectorRule

details GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail]

Details of a Detector Rule

detector str

detector for the rule

detector_rule_id str

The unique identifier of the detector rule

display_name str

A filter to return only resources that match the entire display name given.

lifecycle_details 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 Sequence[str]

List of cloudguard managed list types related to this rule

recommendation str

Recommendation for DetectorRecipeDetectorRule

resource_type str

resource type of the configuration to which the rule is applied

service_type str

service type of the configuration to which the rule is applied

state str

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

time_created str

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

time_updated str

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

candidateResponderRules List<Property Map>

List of CandidateResponderRule related to this rule

description String

Description for DetectorRecipeDetectorRule

details List<Property Map>

Details of a Detector Rule

detector String

detector for the rule

detectorRuleId String

The unique identifier of the detector rule

displayName String

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 List<String>

List of cloudguard managed list types related to this rule

recommendation String

Recommendation for DetectorRecipeDetectorRule

resourceType String

resource type of the configuration to which the rule is applied

serviceType String

service type of the configuration to which the rule is applied

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated String

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

timeUpdated String

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

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule

DisplayName string

A filter to return only resources that match the entire display name given.

Id string

Ocid for detector recipe

IsPreferred bool

Preferred state

DisplayName string

A filter to return only resources that match the entire display name given.

Id string

Ocid for detector recipe

IsPreferred bool

Preferred state

displayName String

A filter to return only resources that match the entire display name given.

id String

Ocid for detector recipe

isPreferred Boolean

Preferred state

displayName string

A filter to return only resources that match the entire display name given.

id string

Ocid for detector recipe

isPreferred boolean

Preferred state

display_name str

A filter to return only resources that match the entire display name given.

id str

Ocid for detector recipe

is_preferred bool

Preferred state

displayName String

A filter to return only resources that match the entire display name given.

id String

Ocid for detector recipe

isPreferred Boolean

Preferred state

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail

Condition string
Configurations List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration>

Configuration details

IsConfigurationAllowed bool

configuration allowed or not

IsEnabled bool

Enables the control

Labels List<string>

user defined labels for a detector rule

RiskLevel string

The Risk Level

Condition string
Configurations []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration

Configuration details

IsConfigurationAllowed bool

configuration allowed or not

IsEnabled bool

Enables the control

Labels []string

user defined labels for a detector rule

RiskLevel string

The Risk Level

condition String
configurations List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration>

Configuration details

isConfigurationAllowed Boolean

configuration allowed or not

isEnabled Boolean

Enables the control

labels List<String>

user defined labels for a detector rule

riskLevel String

The Risk Level

condition string
configurations GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration[]

Configuration details

isConfigurationAllowed boolean

configuration allowed or not

isEnabled boolean

Enables the control

labels string[]

user defined labels for a detector rule

riskLevel string

The Risk Level

condition str
configurations GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration]

Configuration details

is_configuration_allowed bool

configuration allowed or not

is_enabled bool

Enables the control

labels Sequence[str]

user defined labels for a detector rule

risk_level str

The Risk Level

condition String
configurations List<Property Map>

Configuration details

isConfigurationAllowed Boolean

configuration allowed or not

isEnabled Boolean

Enables the control

labels List<String>

user defined labels for a detector rule

riskLevel String

The Risk Level

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration

ConfigKey string

Unique name of the configuration

DataType string

configuration data type

Name string

configuration name

Value string

configuration value

Values List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue>

List of configuration values

ConfigKey string

Unique name of the configuration

DataType string

configuration data type

Name string

configuration name

Value string

configuration value

Values []GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue

List of configuration values

configKey String

Unique name of the configuration

dataType String

configuration data type

name String

configuration name

value String

configuration value

values List<GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue>

List of configuration values

configKey string

Unique name of the configuration

dataType string

configuration data type

name string

configuration name

value string

configuration value

values GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue[]

List of configuration values

config_key str

Unique name of the configuration

data_type str

configuration data type

name str

configuration name

value str

configuration value

values GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue]

List of configuration values

configKey String

Unique name of the configuration

dataType String

configuration data type

name String

configuration name

value String

configuration value

values List<Property Map>

List of configuration values

GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue

ListType string

configuration list item type, either CUSTOM or MANAGED

ManagedListType string

type of the managed list

Value string

configuration value

ListType string

configuration list item type, either CUSTOM or MANAGED

ManagedListType string

type of the managed list

Value string

configuration value

listType String

configuration list item type, either CUSTOM or MANAGED

managedListType String

type of the managed list

value String

configuration value

listType string

configuration list item type, either CUSTOM or MANAGED

managedListType string

type of the managed list

value string

configuration value

list_type str

configuration list item type, either CUSTOM or MANAGED

managed_list_type str

type of the managed list

value str

configuration value

listType String

configuration list item type, either CUSTOM or MANAGED

managedListType String

type of the managed list

value String

configuration value

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule

CandidateResponderRules List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule>

List of CandidateResponderRule related to this rule

Description string

Description for DetectorRecipeDetectorRule

Details List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail>

Details of a Detector Rule

Detector string

detector for the rule

DetectorRuleId string

The unique identifier of the detector rule

DisplayName string

A filter to return only resources that match the entire display name given.

LifecycleDetails 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 List<string>

List of cloudguard managed list types related to this rule

Recommendation string

Recommendation for DetectorRecipeDetectorRule

ResourceType string

resource type of the configuration to which the rule is applied

ServiceType string

service type of the configuration to which the rule is applied

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

TimeCreated string

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

TimeUpdated string

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

CandidateResponderRules []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule

List of CandidateResponderRule related to this rule

Description string

Description for DetectorRecipeDetectorRule

Details []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail

Details of a Detector Rule

Detector string

detector for the rule

DetectorRuleId string

The unique identifier of the detector rule

DisplayName string

A filter to return only resources that match the entire display name given.

LifecycleDetails 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 []string

List of cloudguard managed list types related to this rule

Recommendation string

Recommendation for DetectorRecipeDetectorRule

ResourceType string

resource type of the configuration to which the rule is applied

ServiceType string

service type of the configuration to which the rule is applied

State string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

TimeCreated string

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

TimeUpdated string

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

candidateResponderRules List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule>

List of CandidateResponderRule related to this rule

description String

Description for DetectorRecipeDetectorRule

details List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail>

Details of a Detector Rule

detector String

detector for the rule

detectorRuleId String

The unique identifier of the detector rule

displayName String

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 List<String>

List of cloudguard managed list types related to this rule

recommendation String

Recommendation for DetectorRecipeDetectorRule

resourceType String

resource type of the configuration to which the rule is applied

serviceType String

service type of the configuration to which the rule is applied

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated String

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

timeUpdated String

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

candidateResponderRules GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule[]

List of CandidateResponderRule related to this rule

description string

Description for DetectorRecipeDetectorRule

details GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail[]

Details of a Detector Rule

detector string

detector for the rule

detectorRuleId string

The unique identifier of the detector rule

displayName string

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 string[]

List of cloudguard managed list types related to this rule

recommendation string

Recommendation for DetectorRecipeDetectorRule

resourceType string

resource type of the configuration to which the rule is applied

serviceType string

service type of the configuration to which the rule is applied

state string

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated string

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

timeUpdated string

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

candidate_responder_rules GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule]

List of CandidateResponderRule related to this rule

description str

Description for DetectorRecipeDetectorRule

details GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail]

Details of a Detector Rule

detector str

detector for the rule

detector_rule_id str

The unique identifier of the detector rule

display_name str

A filter to return only resources that match the entire display name given.

lifecycle_details 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 Sequence[str]

List of cloudguard managed list types related to this rule

recommendation str

Recommendation for DetectorRecipeDetectorRule

resource_type str

resource type of the configuration to which the rule is applied

service_type str

service type of the configuration to which the rule is applied

state str

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

time_created str

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

time_updated str

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

candidateResponderRules List<Property Map>

List of CandidateResponderRule related to this rule

description String

Description for DetectorRecipeDetectorRule

details List<Property Map>

Details of a Detector Rule

detector String

detector for the rule

detectorRuleId String

The unique identifier of the detector rule

displayName String

A filter to return only resources that match the entire display name given.

lifecycleDetails 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 List<String>

List of cloudguard managed list types related to this rule

recommendation String

Recommendation for DetectorRecipeDetectorRule

resourceType String

resource type of the configuration to which the rule is applied

serviceType String

service type of the configuration to which the rule is applied

state String

The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

timeCreated String

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

timeUpdated String

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

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule

DisplayName string

A filter to return only resources that match the entire display name given.

Id string

Ocid for detector recipe

IsPreferred bool

Preferred state

DisplayName string

A filter to return only resources that match the entire display name given.

Id string

Ocid for detector recipe

IsPreferred bool

Preferred state

displayName String

A filter to return only resources that match the entire display name given.

id String

Ocid for detector recipe

isPreferred Boolean

Preferred state

displayName string

A filter to return only resources that match the entire display name given.

id string

Ocid for detector recipe

isPreferred boolean

Preferred state

display_name str

A filter to return only resources that match the entire display name given.

id str

Ocid for detector recipe

is_preferred bool

Preferred state

displayName String

A filter to return only resources that match the entire display name given.

id String

Ocid for detector recipe

isPreferred Boolean

Preferred state

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail

Condition string
Configurations List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration>

Configuration details

IsConfigurationAllowed bool

configuration allowed or not

IsEnabled bool

Enables the control

Labels List<string>

user defined labels for a detector rule

RiskLevel string

The Risk Level

Condition string
Configurations []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration

Configuration details

IsConfigurationAllowed bool

configuration allowed or not

IsEnabled bool

Enables the control

Labels []string

user defined labels for a detector rule

RiskLevel string

The Risk Level

condition String
configurations List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration>

Configuration details

isConfigurationAllowed Boolean

configuration allowed or not

isEnabled Boolean

Enables the control

labels List<String>

user defined labels for a detector rule

riskLevel String

The Risk Level

condition string
configurations GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration[]

Configuration details

isConfigurationAllowed boolean

configuration allowed or not

isEnabled boolean

Enables the control

labels string[]

user defined labels for a detector rule

riskLevel string

The Risk Level

condition str
configurations GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration]

Configuration details

is_configuration_allowed bool

configuration allowed or not

is_enabled bool

Enables the control

labels Sequence[str]

user defined labels for a detector rule

risk_level str

The Risk Level

condition String
configurations List<Property Map>

Configuration details

isConfigurationAllowed Boolean

configuration allowed or not

isEnabled Boolean

Enables the control

labels List<String>

user defined labels for a detector rule

riskLevel String

The Risk Level

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration

ConfigKey string

Unique name of the configuration

DataType string

configuration data type

Name string

configuration name

Value string

configuration value

Values List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue>

List of configuration values

ConfigKey string

Unique name of the configuration

DataType string

configuration data type

Name string

configuration name

Value string

configuration value

Values []GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue

List of configuration values

configKey String

Unique name of the configuration

dataType String

configuration data type

name String

configuration name

value String

configuration value

values List<GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue>

List of configuration values

configKey string

Unique name of the configuration

dataType string

configuration data type

name string

configuration name

value string

configuration value

values GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue[]

List of configuration values

config_key str

Unique name of the configuration

data_type str

configuration data type

name str

configuration name

value str

configuration value

values GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue]

List of configuration values

configKey String

Unique name of the configuration

dataType String

configuration data type

name String

configuration name

value String

configuration value

values List<Property Map>

List of configuration values

GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue

ListType string

configuration list item type, either CUSTOM or MANAGED

ManagedListType string

type of the managed list

Value string

configuration value

ListType string

configuration list item type, either CUSTOM or MANAGED

ManagedListType string

type of the managed list

Value string

configuration value

listType String

configuration list item type, either CUSTOM or MANAGED

managedListType String

type of the managed list

value String

configuration value

listType string

configuration list item type, either CUSTOM or MANAGED

managedListType string

type of the managed list

value string

configuration value

list_type str

configuration list item type, either CUSTOM or MANAGED

managed_list_type str

type of the managed list

value str

configuration value

listType String

configuration list item type, either CUSTOM or MANAGED

managedListType String

type of the managed list

value String

configuration value

GetDetectorRecipesFilter

Name string

configuration name

Values List<string>

List of configuration values

Regex bool
Name string

configuration name

Values []string

List of configuration values

Regex bool
name String

configuration name

values List<String>

List of configuration values

regex Boolean
name string

configuration name

values string[]

List of configuration values

regex boolean
name str

configuration name

values Sequence[str]

List of configuration values

regex bool
name String

configuration name

values List<String>

List of configuration values

regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.