import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testDetectorRecipes = oci.cloudguard.getDetectorRecipes({ * compartmentId: compartmentId, * accessLevel: detectorRecipeAccessLevel, * compartmentIdInSubtree: detectorRecipeCompartmentIdInSubtree === "true", * displayName: detectorRecipeDisplayName, * resourceMetadataOnly: detectorRecipeResourceMetadataOnly === "true", * state: detectorRecipeState, * }); * ``` */ export declare function getDetectorRecipes(args: GetDetectorRecipesArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getDetectorRecipes. */ export interface GetDetectorRecipesArgs { /** * 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. */ accessLevel?: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * 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`. */ compartmentIdInSubtree?: boolean; /** * A filter to return only resources that match the entire display name given. */ displayName?: string; filters?: inputs.CloudGuard.GetDetectorRecipesFilter[]; /** * Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned. */ resourceMetadataOnly?: boolean; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state?: string; } /** * A collection of values returned by getDetectorRecipes. */ export interface GetDetectorRecipesResult { readonly accessLevel?: string; /** * Compartment OCID of detector recipe */ readonly compartmentId: string; readonly compartmentIdInSubtree?: boolean; /** * The list of detector_recipe_collection. */ readonly detectorRecipeCollections: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollection[]; /** * Display name of the entity */ readonly displayName?: string; readonly filters?: outputs.CloudGuard.GetDetectorRecipesFilter[]; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly resourceMetadataOnly?: boolean; /** * The current lifecycle state of the resource */ readonly state?: string; } /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testDetectorRecipes = oci.cloudguard.getDetectorRecipes({ * compartmentId: compartmentId, * accessLevel: detectorRecipeAccessLevel, * compartmentIdInSubtree: detectorRecipeCompartmentIdInSubtree === "true", * displayName: detectorRecipeDisplayName, * resourceMetadataOnly: detectorRecipeResourceMetadataOnly === "true", * state: detectorRecipeState, * }); * ``` */ export declare function getDetectorRecipesOutput(args: GetDetectorRecipesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getDetectorRecipes. */ export interface GetDetectorRecipesOutputArgs { /** * 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. */ accessLevel?: pulumi.Input; /** * The OCID of the compartment in which to list resources. */ compartmentId: pulumi.Input; /** * 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`. */ compartmentIdInSubtree?: pulumi.Input; /** * A filter to return only resources that match the entire display name given. */ displayName?: pulumi.Input; filters?: pulumi.Input[] | undefined>; /** * Default is false. When set to true, the list of all Oracle-managed resources metadata supported by Cloud Guard is returned. */ resourceMetadataOnly?: pulumi.Input; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state?: pulumi.Input; } //# sourceMappingURL=getDetectorRecipes.d.ts.map