oci.CloudGuard.DetectorRecipe
Explore with Pulumi AI
This resource provides the Detector Recipe resource in Oracle Cloud Infrastructure Cloud Guard service.
Creates a new DetectorRecipe resource.
Create DetectorRecipe Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DetectorRecipe(name: string, args: DetectorRecipeArgs, opts?: CustomResourceOptions);
@overload
def DetectorRecipe(resource_name: str,
args: DetectorRecipeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DetectorRecipe(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
detector: Optional[str] = None,
detector_rules: Optional[Sequence[_cloudguard.DetectorRecipeDetectorRuleArgs]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
source_detector_recipe_id: Optional[str] = None)
func NewDetectorRecipe(ctx *Context, name string, args DetectorRecipeArgs, opts ...ResourceOption) (*DetectorRecipe, error)
public DetectorRecipe(string name, DetectorRecipeArgs args, CustomResourceOptions? opts = null)
public DetectorRecipe(String name, DetectorRecipeArgs args)
public DetectorRecipe(String name, DetectorRecipeArgs args, CustomResourceOptions options)
type: oci:CloudGuard:DetectorRecipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DetectorRecipeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DetectorRecipeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DetectorRecipeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DetectorRecipeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DetectorRecipeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var detectorRecipeResource = new Oci.CloudGuard.DetectorRecipe("detectorRecipeResource", new()
{
CompartmentId = "string",
DisplayName = "string",
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
Detector = "string",
DetectorRules = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleArgs
{
Details = new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleDetailsArgs
{
IsEnabled = false,
RiskLevel = "string",
Condition = "string",
Configurations = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleDetailsConfigurationArgs
{
ConfigKey = "string",
Name = "string",
DataType = "string",
Value = "string",
Values = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleDetailsConfigurationValueArgs
{
ListType = "string",
ManagedListType = "string",
Value = "string",
},
},
},
},
DataSourceId = "string",
Description = "string",
EntitiesMappings = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleDetailsEntitiesMappingArgs
{
QueryField = "string",
DisplayName = "string",
EntityType = "string",
},
},
IsConfigurationAllowed = false,
Labels = new[]
{
"string",
},
Recommendation = "string",
},
DetectorRuleId = "string",
LifecycleDetails = "string",
ManagedListTypes = new[]
{
"string",
},
Detector = "string",
DataSourceId = "string",
DisplayName = "string",
EntitiesMappings = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleEntitiesMappingArgs
{
DisplayName = "string",
EntityType = "string",
QueryField = "string",
},
},
CandidateResponderRules = new[]
{
new Oci.CloudGuard.Inputs.DetectorRecipeDetectorRuleCandidateResponderRuleArgs
{
DisplayName = "string",
Id = "string",
IsPreferred = false,
},
},
Description = "string",
Recommendation = "string",
ResourceType = "string",
ServiceType = "string",
State = "string",
TimeCreated = "string",
TimeUpdated = "string",
},
},
FreeformTags =
{
{ "string", "string" },
},
SourceDetectorRecipeId = "string",
});
example, err := CloudGuard.NewDetectorRecipe(ctx, "detectorRecipeResource", &CloudGuard.DetectorRecipeArgs{
CompartmentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Detector: pulumi.String("string"),
DetectorRules: cloudguard.DetectorRecipeDetectorRuleArray{
&cloudguard.DetectorRecipeDetectorRuleArgs{
Details: &cloudguard.DetectorRecipeDetectorRuleDetailsArgs{
IsEnabled: pulumi.Bool(false),
RiskLevel: pulumi.String("string"),
Condition: pulumi.String("string"),
Configurations: cloudguard.DetectorRecipeDetectorRuleDetailsConfigurationArray{
&cloudguard.DetectorRecipeDetectorRuleDetailsConfigurationArgs{
ConfigKey: pulumi.String("string"),
Name: pulumi.String("string"),
DataType: pulumi.String("string"),
Value: pulumi.String("string"),
Values: cloudguard.DetectorRecipeDetectorRuleDetailsConfigurationValueArray{
&cloudguard.DetectorRecipeDetectorRuleDetailsConfigurationValueArgs{
ListType: pulumi.String("string"),
ManagedListType: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
DataSourceId: pulumi.String("string"),
Description: pulumi.String("string"),
EntitiesMappings: cloudguard.DetectorRecipeDetectorRuleDetailsEntitiesMappingArray{
&cloudguard.DetectorRecipeDetectorRuleDetailsEntitiesMappingArgs{
QueryField: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EntityType: pulumi.String("string"),
},
},
IsConfigurationAllowed: pulumi.Bool(false),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Recommendation: pulumi.String("string"),
},
DetectorRuleId: pulumi.String("string"),
LifecycleDetails: pulumi.String("string"),
ManagedListTypes: pulumi.StringArray{
pulumi.String("string"),
},
Detector: pulumi.String("string"),
DataSourceId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EntitiesMappings: cloudguard.DetectorRecipeDetectorRuleEntitiesMappingArray{
&cloudguard.DetectorRecipeDetectorRuleEntitiesMappingArgs{
DisplayName: pulumi.String("string"),
EntityType: pulumi.String("string"),
QueryField: pulumi.String("string"),
},
},
CandidateResponderRules: cloudguard.DetectorRecipeDetectorRuleCandidateResponderRuleArray{
&cloudguard.DetectorRecipeDetectorRuleCandidateResponderRuleArgs{
DisplayName: pulumi.String("string"),
Id: pulumi.String("string"),
IsPreferred: pulumi.Bool(false),
},
},
Description: pulumi.String("string"),
Recommendation: pulumi.String("string"),
ResourceType: pulumi.String("string"),
ServiceType: pulumi.String("string"),
State: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
},
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
SourceDetectorRecipeId: pulumi.String("string"),
})
var detectorRecipeResource = new DetectorRecipe("detectorRecipeResource", DetectorRecipeArgs.builder()
.compartmentId("string")
.displayName("string")
.definedTags(Map.of("string", "string"))
.description("string")
.detector("string")
.detectorRules(DetectorRecipeDetectorRuleArgs.builder()
.details(DetectorRecipeDetectorRuleDetailsArgs.builder()
.isEnabled(false)
.riskLevel("string")
.condition("string")
.configurations(DetectorRecipeDetectorRuleDetailsConfigurationArgs.builder()
.configKey("string")
.name("string")
.dataType("string")
.value("string")
.values(DetectorRecipeDetectorRuleDetailsConfigurationValueArgs.builder()
.listType("string")
.managedListType("string")
.value("string")
.build())
.build())
.dataSourceId("string")
.description("string")
.entitiesMappings(DetectorRecipeDetectorRuleDetailsEntitiesMappingArgs.builder()
.queryField("string")
.displayName("string")
.entityType("string")
.build())
.isConfigurationAllowed(false)
.labels("string")
.recommendation("string")
.build())
.detectorRuleId("string")
.lifecycleDetails("string")
.managedListTypes("string")
.detector("string")
.dataSourceId("string")
.displayName("string")
.entitiesMappings(DetectorRecipeDetectorRuleEntitiesMappingArgs.builder()
.displayName("string")
.entityType("string")
.queryField("string")
.build())
.candidateResponderRules(DetectorRecipeDetectorRuleCandidateResponderRuleArgs.builder()
.displayName("string")
.id("string")
.isPreferred(false)
.build())
.description("string")
.recommendation("string")
.resourceType("string")
.serviceType("string")
.state("string")
.timeCreated("string")
.timeUpdated("string")
.build())
.freeformTags(Map.of("string", "string"))
.sourceDetectorRecipeId("string")
.build());
detector_recipe_resource = oci.cloud_guard.DetectorRecipe("detectorRecipeResource",
compartment_id="string",
display_name="string",
defined_tags={
"string": "string",
},
description="string",
detector="string",
detector_rules=[{
"details": {
"is_enabled": False,
"risk_level": "string",
"condition": "string",
"configurations": [{
"config_key": "string",
"name": "string",
"data_type": "string",
"value": "string",
"values": [{
"list_type": "string",
"managed_list_type": "string",
"value": "string",
}],
}],
"data_source_id": "string",
"description": "string",
"entities_mappings": [{
"query_field": "string",
"display_name": "string",
"entity_type": "string",
}],
"is_configuration_allowed": False,
"labels": ["string"],
"recommendation": "string",
},
"detector_rule_id": "string",
"lifecycle_details": "string",
"managed_list_types": ["string"],
"detector": "string",
"data_source_id": "string",
"display_name": "string",
"entities_mappings": [{
"display_name": "string",
"entity_type": "string",
"query_field": "string",
}],
"candidate_responder_rules": [{
"display_name": "string",
"id": "string",
"is_preferred": False,
}],
"description": "string",
"recommendation": "string",
"resource_type": "string",
"service_type": "string",
"state": "string",
"time_created": "string",
"time_updated": "string",
}],
freeform_tags={
"string": "string",
},
source_detector_recipe_id="string")
const detectorRecipeResource = new oci.cloudguard.DetectorRecipe("detectorRecipeResource", {
compartmentId: "string",
displayName: "string",
definedTags: {
string: "string",
},
description: "string",
detector: "string",
detectorRules: [{
details: {
isEnabled: false,
riskLevel: "string",
condition: "string",
configurations: [{
configKey: "string",
name: "string",
dataType: "string",
value: "string",
values: [{
listType: "string",
managedListType: "string",
value: "string",
}],
}],
dataSourceId: "string",
description: "string",
entitiesMappings: [{
queryField: "string",
displayName: "string",
entityType: "string",
}],
isConfigurationAllowed: false,
labels: ["string"],
recommendation: "string",
},
detectorRuleId: "string",
lifecycleDetails: "string",
managedListTypes: ["string"],
detector: "string",
dataSourceId: "string",
displayName: "string",
entitiesMappings: [{
displayName: "string",
entityType: "string",
queryField: "string",
}],
candidateResponderRules: [{
displayName: "string",
id: "string",
isPreferred: false,
}],
description: "string",
recommendation: "string",
resourceType: "string",
serviceType: "string",
state: "string",
timeCreated: "string",
timeUpdated: "string",
}],
freeformTags: {
string: "string",
},
sourceDetectorRecipeId: "string",
});
type: oci:CloudGuard:DetectorRecipe
properties:
compartmentId: string
definedTags:
string: string
description: string
detector: string
detectorRules:
- candidateResponderRules:
- displayName: string
id: string
isPreferred: false
dataSourceId: string
description: string
details:
condition: string
configurations:
- configKey: string
dataType: string
name: string
value: string
values:
- listType: string
managedListType: string
value: string
dataSourceId: string
description: string
entitiesMappings:
- displayName: string
entityType: string
queryField: string
isConfigurationAllowed: false
isEnabled: false
labels:
- string
recommendation: string
riskLevel: string
detector: string
detectorRuleId: string
displayName: string
entitiesMappings:
- displayName: string
entityType: string
queryField: string
lifecycleDetails: string
managedListTypes:
- string
recommendation: string
resourceType: string
serviceType: string
state: string
timeCreated: string
timeUpdated: string
displayName: string
freeformTags:
string: string
sourceDetectorRecipeId: string
DetectorRecipe Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DetectorRecipe resource accepts the following input properties:
- Compartment
Id string - (Updatable) Compartment OCID
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Detector
Rules List<DetectorRecipe Detector Rule> - (Updatable) Detector rules to override from source detector recipe
- Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- Source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) Compartment OCID
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Detector
Rules []DetectorRecipe Detector Rule Args - (Updatable) Detector rules to override from source detector recipe
- map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- Source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) Compartment OCID
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- detector
Rules List<DetectorRecipe Detector Rule> - (Updatable) Detector rules to override from source detector recipe
- Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- source
Detector StringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) Compartment OCID
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector string
- Detector for the rule
- detector
Rules DetectorRecipe Detector Rule[] - (Updatable) Detector rules to override from source detector recipe
- {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) Compartment OCID
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector str
- Detector for the rule
- detector_
rules Sequence[cloudguard.Detector Recipe Detector Rule Args] - (Updatable) Detector rules to override from source detector recipe
- Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- source_
detector_ strrecipe_ id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) Compartment OCID
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- detector
Rules List<Property Map> - (Updatable) Detector rules to override from source detector recipe
- Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- source
Detector StringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the DetectorRecipe resource produces the following output properties:
- Detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- Effective
Detector List<DetectorRules Recipe Effective Detector Rule> - List of effective detector rules for the detector type for recipe after applying defaults
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- Owner of detector recipe
- State string
- The current lifecycle state of the resource
- 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"}
- Target
Ids List<string> - List of target IDs to which the recipe is attached
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- Detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- Effective
Detector []DetectorRules Recipe Effective Detector Rule - List of effective detector rules for the detector type for recipe after applying defaults
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- Owner of detector recipe
- State string
- The current lifecycle state of the resource
- 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"}
- Target
Ids []string - List of target IDs to which the recipe is attached
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- detector
Recipe StringType - Recipe type ( STANDARD, ENTERPRISE )
- effective
Detector List<DetectorRules Recipe Effective Detector Rule> - List of effective detector rules for the detector type for recipe after applying defaults
- id String
- The provider-assigned unique ID for this managed resource.
- owner String
- Owner of detector recipe
- state String
- The current lifecycle state of the resource
- 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"}
- target
Ids List<String> - List of target IDs to which the recipe is attached
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
- detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- effective
Detector DetectorRules Recipe Effective Detector Rule[] - List of effective detector rules for the detector type for recipe after applying defaults
- id string
- The provider-assigned unique ID for this managed resource.
- owner string
- Owner of detector recipe
- state string
- The current lifecycle state of the resource
- {[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"}
- target
Ids string[] - List of target IDs to which the recipe is attached
- time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- detector_
recipe_ strtype - Recipe type ( STANDARD, ENTERPRISE )
- effective_
detector_ Sequence[cloudguard.rules Detector Recipe Effective Detector Rule] - List of effective detector rules for the detector type for recipe after applying defaults
- id str
- The provider-assigned unique ID for this managed resource.
- owner str
- Owner of detector recipe
- state str
- The current lifecycle state of the resource
- 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 Sequence[str] - List of target IDs to which the recipe is attached
- 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 last updated Format defined by RFC3339.
- detector
Recipe StringType - Recipe type ( STANDARD, ENTERPRISE )
- effective
Detector List<Property Map>Rules - List of effective detector rules for the detector type for recipe after applying defaults
- id String
- The provider-assigned unique ID for this managed resource.
- owner String
- Owner of detector recipe
- state String
- The current lifecycle state of the resource
- 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"}
- target
Ids List<String> - List of target IDs to which the recipe is attached
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
Look up Existing DetectorRecipe Resource
Get an existing DetectorRecipe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DetectorRecipeState, opts?: CustomResourceOptions): DetectorRecipe
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
detector: Optional[str] = None,
detector_recipe_type: Optional[str] = None,
detector_rules: Optional[Sequence[_cloudguard.DetectorRecipeDetectorRuleArgs]] = None,
display_name: Optional[str] = None,
effective_detector_rules: Optional[Sequence[_cloudguard.DetectorRecipeEffectiveDetectorRuleArgs]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
owner: Optional[str] = None,
source_detector_recipe_id: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
target_ids: Optional[Sequence[str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> DetectorRecipe
func GetDetectorRecipe(ctx *Context, name string, id IDInput, state *DetectorRecipeState, opts ...ResourceOption) (*DetectorRecipe, error)
public static DetectorRecipe Get(string name, Input<string> id, DetectorRecipeState? state, CustomResourceOptions? opts = null)
public static DetectorRecipe get(String name, Output<String> id, DetectorRecipeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Compartment
Id string - (Updatable) Compartment OCID
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- Detector
Rules List<DetectorRecipe Detector Rule> - (Updatable) Detector rules to override from source detector recipe
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Effective
Detector List<DetectorRules Recipe Effective Detector Rule> - List of effective detector rules for the detector type for recipe after applying defaults
- Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- Owner string
- Owner of detector recipe
- Source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current lifecycle state of the resource
- 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"}
- Target
Ids List<string> - List of target IDs to which the recipe is attached
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- Compartment
Id string - (Updatable) Compartment OCID
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- Detector
Rules []DetectorRecipe Detector Rule Args - (Updatable) Detector rules to override from source detector recipe
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Effective
Detector []DetectorRules Recipe Effective Detector Rule Args - List of effective detector rules for the detector type for recipe after applying defaults
- map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- Owner string
- Owner of detector recipe
- Source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- State string
- The current lifecycle state of the resource
- 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"}
- Target
Ids []string - List of target IDs to which the recipe is attached
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- compartment
Id String - (Updatable) Compartment OCID
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- detector
Recipe StringType - Recipe type ( STANDARD, ENTERPRISE )
- detector
Rules List<DetectorRecipe Detector Rule> - (Updatable) Detector rules to override from source detector recipe
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- effective
Detector List<DetectorRules Recipe Effective Detector Rule> - List of effective detector rules for the detector type for recipe after applying defaults
- Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- owner String
- Owner of detector recipe
- source
Detector StringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current lifecycle state of the resource
- 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"}
- target
Ids List<String> - List of target IDs to which the recipe is attached
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
- compartment
Id string - (Updatable) Compartment OCID
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector string
- Detector for the rule
- detector
Recipe stringType - Recipe type ( STANDARD, ENTERPRISE )
- detector
Rules DetectorRecipe Detector Rule[] - (Updatable) Detector rules to override from source detector recipe
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- effective
Detector DetectorRules Recipe Effective Detector Rule[] - List of effective detector rules for the detector type for recipe after applying defaults
- {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- owner string
- Owner of detector recipe
- source
Detector stringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state string
- The current lifecycle state of the resource
- {[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"}
- target
Ids string[] - List of target IDs to which the recipe is attached
- time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- compartment_
id str - (Updatable) Compartment OCID
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector str
- Detector for the rule
- detector_
recipe_ strtype - Recipe type ( STANDARD, ENTERPRISE )
- detector_
rules Sequence[cloudguard.Detector Recipe Detector Rule Args] - (Updatable) Detector rules to override from source detector recipe
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- effective_
detector_ Sequence[cloudguard.rules Detector Recipe Effective Detector Rule Args] - List of effective detector rules for the detector type for recipe after applying defaults
- Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- owner str
- Owner of detector recipe
- source_
detector_ strrecipe_ id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state str
- The current lifecycle state of the resource
- 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 Sequence[str] - List of target IDs to which the recipe is attached
- 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 last updated Format defined by RFC3339.
- compartment
Id String - (Updatable) Compartment OCID
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- detector
Recipe StringType - Recipe type ( STANDARD, ENTERPRISE )
- detector
Rules List<Property Map> - (Updatable) Detector rules to override from source detector recipe
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- effective
Detector List<Property Map>Rules - List of effective detector rules for the detector type for recipe after applying defaults
- Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
Avoid entering confidential information.
- owner String
- Owner of detector recipe
- source
Detector StringRecipe Id The ID of the source detector recipe
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- state String
- The current lifecycle state of the resource
- 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"}
- target
Ids List<String> - List of target IDs to which the recipe is attached
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
Supporting Types
DetectorRecipeDetectorRule, DetectorRecipeDetectorRuleArgs
- Details
Detector
Recipe Detector Rule Details - (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- Detector
Rule stringId - (Updatable) Detector recipe rule ID
- Candidate
Responder List<DetectorRules Recipe Detector Rule Candidate Responder Rule> - List of responder rules that can be used to remediate this detector rule
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entities
Mappings List<DetectorRecipe Detector Rule Entities Mapping> - Data source entities mapping for the detector rule
- Lifecycle
Details 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.
- Managed
List List<string>Types - List of managed list types related to this rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Resource
Type string - Resource type of the configuration to which the rule is applied
- Service
Type string - Service type of the configuration to which the rule is applied
- State string
- The current lifecycle state of the resource
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- Details
Detector
Recipe Detector Rule Details - (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- Detector
Rule stringId - (Updatable) Detector recipe rule ID
- Candidate
Responder []DetectorRules Recipe Detector Rule Candidate Responder Rule - List of responder rules that can be used to remediate this detector rule
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Detector string
- Detector for the rule
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entities
Mappings []DetectorRecipe Detector Rule Entities Mapping - Data source entities mapping for the detector rule
- Lifecycle
Details 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.
- Managed
List []stringTypes - List of managed list types related to this rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Resource
Type string - Resource type of the configuration to which the rule is applied
- Service
Type string - Service type of the configuration to which the rule is applied
- State string
- The current lifecycle state of the resource
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- details
Detector
Recipe Detector Rule Details - (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- detector
Rule StringId - (Updatable) Detector recipe rule ID
- candidate
Responder List<DetectorRules Recipe Detector Rule Candidate Responder Rule> - List of responder rules that can be used to remediate this detector rule
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings List<DetectorRecipe Detector Rule Entities Mapping> - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List List<String>Types - List of managed list types related to this rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type String - Resource type of the configuration to which the rule is applied
- service
Type String - Service type of the configuration to which the rule is applied
- state String
- The current lifecycle state of the resource
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
- details
Detector
Recipe Detector Rule Details - (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- detector
Rule stringId - (Updatable) Detector recipe rule ID
- candidate
Responder DetectorRules Recipe Detector Rule Candidate Responder Rule[] - List of responder rules that can be used to remediate this detector rule
- data
Source stringId - The ID of the attached data source
- description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector string
- Detector for the rule
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings DetectorRecipe Detector Rule Entities Mapping[] - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List string[]Types - List of managed list types related to this rule
- recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type string - Resource type of the configuration to which the rule is applied
- service
Type string - Service type of the configuration to which the rule is applied
- state string
- The current lifecycle state of the resource
- time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- details
cloudguard.
Detector Recipe Detector Rule Details - (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- detector_
rule_ strid - (Updatable) Detector recipe rule ID
- candidate_
responder_ Sequence[cloudguard.rules Detector Recipe Detector Rule Candidate Responder Rule] - List of responder rules that can be used to remediate this detector rule
- data_
source_ strid - The ID of the attached data source
- description str
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector str
- Detector for the rule
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities_
mappings Sequence[cloudguard.Detector Recipe Detector Rule Entities Mapping] - Data source entities mapping for the detector rule
- 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_ Sequence[str]types - List of managed list types related to this rule
- recommendation str
- Recommendation for DetectorRecipeDetectorRule resource
- 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 current lifecycle state of the resource
- 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 last updated Format defined by RFC3339.
- details Property Map
- (Updatable) Parameters to be updated for a detector rule within a detector recipe.
- detector
Rule StringId - (Updatable) Detector recipe rule ID
- candidate
Responder List<Property Map>Rules - List of responder rules that can be used to remediate this detector rule
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- detector String
- Detector for the rule
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings List<Property Map> - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List List<String>Types - List of managed list types related to this rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type String - Resource type of the configuration to which the rule is applied
- service
Type String - Service type of the configuration to which the rule is applied
- state String
- The current lifecycle state of the resource
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
DetectorRecipeDetectorRuleCandidateResponderRule, DetectorRecipeDetectorRuleCandidateResponderRuleArgs
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Id string
- OCID for detector recipe
- Is
Preferred bool - Is this the preferred state?
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Id string
- OCID for detector recipe
- Is
Preferred bool - Is this the preferred state?
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id String
- OCID for detector recipe
- is
Preferred Boolean - Is this the preferred state?
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id string
- OCID for detector recipe
- is
Preferred boolean - Is this the preferred state?
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id str
- OCID for detector recipe
- is_
preferred bool - Is this the preferred state?
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id String
- OCID for detector recipe
- is
Preferred Boolean - Is this the preferred state?
DetectorRecipeDetectorRuleDetails, DetectorRecipeDetectorRuleDetailsArgs
- Is
Enabled bool - (Updatable) Enablement status of the detector rule
- Risk
Level string - (Updatable) The risk level of the detector rule
- Condition string
- (Updatable) The base condition resource.
- Configurations
List<Detector
Recipe Detector Rule Details Configuration> - (Updatable) List of detector rule configurations
- Data
Source stringId - (Updatable) The unique identifier of the attached data source
- Description string
- (Updatable) Description for the detector rule
- Entities
Mappings List<DetectorRecipe Detector Rule Details Entities Mapping> - (Updatable) Data source entities mapping for a detector rule
- Is
Configuration boolAllowed - Can the rule be configured?
- Labels List<string>
- (Updatable) User-defined labels for a detector rule
- Recommendation string
- (Updatable) Recommendation for the detector rule
- Is
Enabled bool - (Updatable) Enablement status of the detector rule
- Risk
Level string - (Updatable) The risk level of the detector rule
- Condition string
- (Updatable) The base condition resource.
- Configurations
[]Detector
Recipe Detector Rule Details Configuration - (Updatable) List of detector rule configurations
- Data
Source stringId - (Updatable) The unique identifier of the attached data source
- Description string
- (Updatable) Description for the detector rule
- Entities
Mappings []DetectorRecipe Detector Rule Details Entities Mapping - (Updatable) Data source entities mapping for a detector rule
- Is
Configuration boolAllowed - Can the rule be configured?
- Labels []string
- (Updatable) User-defined labels for a detector rule
- Recommendation string
- (Updatable) Recommendation for the detector rule
- is
Enabled Boolean - (Updatable) Enablement status of the detector rule
- risk
Level String - (Updatable) The risk level of the detector rule
- condition String
- (Updatable) The base condition resource.
- configurations
List<Detector
Recipe Detector Rule Details Configuration> - (Updatable) List of detector rule configurations
- data
Source StringId - (Updatable) The unique identifier of the attached data source
- description String
- (Updatable) Description for the detector rule
- entities
Mappings List<DetectorRecipe Detector Rule Details Entities Mapping> - (Updatable) Data source entities mapping for a detector rule
- is
Configuration BooleanAllowed - Can the rule be configured?
- labels List<String>
- (Updatable) User-defined labels for a detector rule
- recommendation String
- (Updatable) Recommendation for the detector rule
- is
Enabled boolean - (Updatable) Enablement status of the detector rule
- risk
Level string - (Updatable) The risk level of the detector rule
- condition string
- (Updatable) The base condition resource.
- configurations
Detector
Recipe Detector Rule Details Configuration[] - (Updatable) List of detector rule configurations
- data
Source stringId - (Updatable) The unique identifier of the attached data source
- description string
- (Updatable) Description for the detector rule
- entities
Mappings DetectorRecipe Detector Rule Details Entities Mapping[] - (Updatable) Data source entities mapping for a detector rule
- is
Configuration booleanAllowed - Can the rule be configured?
- labels string[]
- (Updatable) User-defined labels for a detector rule
- recommendation string
- (Updatable) Recommendation for the detector rule
- is_
enabled bool - (Updatable) Enablement status of the detector rule
- risk_
level str - (Updatable) The risk level of the detector rule
- condition str
- (Updatable) The base condition resource.
- configurations
Sequence[cloudguard.
Detector Recipe Detector Rule Details Configuration] - (Updatable) List of detector rule configurations
- data_
source_ strid - (Updatable) The unique identifier of the attached data source
- description str
- (Updatable) Description for the detector rule
- entities_
mappings Sequence[cloudguard.Detector Recipe Detector Rule Details Entities Mapping] - (Updatable) Data source entities mapping for a detector rule
- is_
configuration_ boolallowed - Can the rule be configured?
- labels Sequence[str]
- (Updatable) User-defined labels for a detector rule
- recommendation str
- (Updatable) Recommendation for the detector rule
- is
Enabled Boolean - (Updatable) Enablement status of the detector rule
- risk
Level String - (Updatable) The risk level of the detector rule
- condition String
- (Updatable) The base condition resource.
- configurations List<Property Map>
- (Updatable) List of detector rule configurations
- data
Source StringId - (Updatable) The unique identifier of the attached data source
- description String
- (Updatable) Description for the detector rule
- entities
Mappings List<Property Map> - (Updatable) Data source entities mapping for a detector rule
- is
Configuration BooleanAllowed - Can the rule be configured?
- labels List<String>
- (Updatable) User-defined labels for a detector rule
- recommendation String
- (Updatable) Recommendation for the detector rule
DetectorRecipeDetectorRuleDetailsConfiguration, DetectorRecipeDetectorRuleDetailsConfigurationArgs
- Config
Key string - (Updatable) Unique identifier of the configuration
- Name string
- (Updatable) Configuration name
- Data
Type string - (Updatable) Configuration data type
- Value string
- (Updatable) Configuration value
- Values
List<Detector
Recipe Detector Rule Details Configuration Value> - (Updatable) List of configuration values
- Config
Key string - (Updatable) Unique identifier of the configuration
- Name string
- (Updatable) Configuration name
- Data
Type string - (Updatable) Configuration data type
- Value string
- (Updatable) Configuration value
- Values
[]Detector
Recipe Detector Rule Details Configuration Value - (Updatable) List of configuration values
- config
Key String - (Updatable) Unique identifier of the configuration
- name String
- (Updatable) Configuration name
- data
Type String - (Updatable) Configuration data type
- value String
- (Updatable) Configuration value
- values
List<Detector
Recipe Detector Rule Details Configuration Value> - (Updatable) List of configuration values
- config
Key string - (Updatable) Unique identifier of the configuration
- name string
- (Updatable) Configuration name
- data
Type string - (Updatable) Configuration data type
- value string
- (Updatable) Configuration value
- values
Detector
Recipe Detector Rule Details Configuration Value[] - (Updatable) List of configuration values
- config_
key str - (Updatable) Unique identifier of the configuration
- name str
- (Updatable) Configuration name
- data_
type str - (Updatable) Configuration data type
- value str
- (Updatable) Configuration value
- values
Sequence[cloudguard.
Detector Recipe Detector Rule Details Configuration Value] - (Updatable) List of configuration values
DetectorRecipeDetectorRuleDetailsConfigurationValue, DetectorRecipeDetectorRuleDetailsConfigurationValueArgs
- List
Type string - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- Managed
List stringType - (Updatable) Type of content in the managed list
- Value string
- (Updatable) Configuration value
- List
Type string - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- Managed
List stringType - (Updatable) Type of content in the managed list
- Value string
- (Updatable) Configuration value
- list
Type String - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- managed
List StringType - (Updatable) Type of content in the managed list
- value String
- (Updatable) Configuration value
- list
Type string - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- managed
List stringType - (Updatable) Type of content in the managed list
- value string
- (Updatable) Configuration value
- list_
type str - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- managed_
list_ strtype - (Updatable) Type of content in the managed list
- value str
- (Updatable) Configuration value
- list
Type String - (Updatable) Configuration list item type (CUSTOM or MANAGED)
- managed
List StringType - (Updatable) Type of content in the managed list
- value String
- (Updatable) Configuration value
DetectorRecipeDetectorRuleDetailsEntitiesMapping, DetectorRecipeDetectorRuleDetailsEntitiesMappingArgs
- Query
Field string - (Updatable) The entity value mapped to a data source query
- Display
Name string - (Updatable) Display name of the entity
- Entity
Type string - (Updatable) Type of entity
- Query
Field string - (Updatable) The entity value mapped to a data source query
- Display
Name string - (Updatable) Display name of the entity
- Entity
Type string - (Updatable) Type of entity
- query
Field String - (Updatable) The entity value mapped to a data source query
- display
Name String - (Updatable) Display name of the entity
- entity
Type String - (Updatable) Type of entity
- query
Field string - (Updatable) The entity value mapped to a data source query
- display
Name string - (Updatable) Display name of the entity
- entity
Type string - (Updatable) Type of entity
- query_
field str - (Updatable) The entity value mapped to a data source query
- display_
name str - (Updatable) Display name of the entity
- entity_
type str - (Updatable) Type of entity
- query
Field String - (Updatable) The entity value mapped to a data source query
- display
Name String - (Updatable) Display name of the entity
- entity
Type String - (Updatable) Type of entity
DetectorRecipeDetectorRuleEntitiesMapping, DetectorRecipeDetectorRuleEntitiesMappingArgs
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type string - Type of entity
- query
Field string - The entity value mapped to a data source query
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity_
type str - Type of entity
- query_
field str - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
DetectorRecipeEffectiveDetectorRule, DetectorRecipeEffectiveDetectorRuleArgs
- Candidate
Responder List<DetectorRules Recipe Effective Detector Rule Candidate Responder Rule> - List of responder rules that can be used to remediate this detector rule
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Details
List<Detector
Recipe Effective Detector Rule Detail> - Detailed information for a detector.
- Detector string
- Detector for the rule
- Detector
Rule stringId - The unique identifier of the detector rule.
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entities
Mappings List<DetectorRecipe Effective Detector Rule Entities Mapping> - Data source entities mapping for the detector rule
- Lifecycle
Details 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.
- Managed
List List<string>Types - List of managed list types related to this rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Resource
Type string - Resource type of the configuration to which the rule is applied
- Service
Type string - Service type of the configuration to which the rule is applied
- State string
- The current lifecycle state of the resource
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- Candidate
Responder []DetectorRules Recipe Effective Detector Rule Candidate Responder Rule - List of responder rules that can be used to remediate this detector rule
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Details
[]Detector
Recipe Effective Detector Rule Detail - Detailed information for a detector.
- Detector string
- Detector for the rule
- Detector
Rule stringId - The unique identifier of the detector rule.
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entities
Mappings []DetectorRecipe Effective Detector Rule Entities Mapping - Data source entities mapping for the detector rule
- Lifecycle
Details 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.
- Managed
List []stringTypes - List of managed list types related to this rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Resource
Type string - Resource type of the configuration to which the rule is applied
- Service
Type string - Service type of the configuration to which the rule is applied
- State string
- The current lifecycle state of the resource
- Time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- Time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- candidate
Responder List<DetectorRules Recipe Effective Detector Rule Candidate Responder Rule> - List of responder rules that can be used to remediate this detector rule
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- details
List<Detector
Recipe Effective Detector Rule Detail> - Detailed information for a detector.
- detector String
- Detector for the rule
- detector
Rule StringId - The unique identifier of the detector rule.
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings List<DetectorRecipe Effective Detector Rule Entities Mapping> - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List List<String>Types - List of managed list types related to this rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type String - Resource type of the configuration to which the rule is applied
- service
Type String - Service type of the configuration to which the rule is applied
- state String
- The current lifecycle state of the resource
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
- candidate
Responder DetectorRules Recipe Effective Detector Rule Candidate Responder Rule[] - List of responder rules that can be used to remediate this detector rule
- data
Source stringId - The ID of the attached data source
- description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- details
Detector
Recipe Effective Detector Rule Detail[] - Detailed information for a detector.
- detector string
- Detector for the rule
- detector
Rule stringId - The unique identifier of the detector rule.
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings DetectorRecipe Effective Detector Rule Entities Mapping[] - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List string[]Types - List of managed list types related to this rule
- recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type string - Resource type of the configuration to which the rule is applied
- service
Type string - Service type of the configuration to which the rule is applied
- state string
- The current lifecycle state of the resource
- time
Created string - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated string - The date and time the detector recipe was last updated Format defined by RFC3339.
- candidate_
responder_ Sequence[cloudguard.rules Detector Recipe Effective Detector Rule Candidate Responder Rule] - List of responder rules that can be used to remediate this detector rule
- data_
source_ strid - The ID of the attached data source
- description str
(Updatable) Detector recipe description.
Avoid entering confidential information.
- details
Sequence[cloudguard.
Detector Recipe Effective Detector Rule Detail] - Detailed information for a detector.
- detector str
- Detector for the rule
- detector_
rule_ strid - The unique identifier of the detector rule.
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities_
mappings Sequence[cloudguard.Detector Recipe Effective Detector Rule Entities Mapping] - Data source entities mapping for the detector rule
- 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_ Sequence[str]types - List of managed list types related to this rule
- recommendation str
- Recommendation for DetectorRecipeDetectorRule resource
- 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 current lifecycle state of the resource
- 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 last updated Format defined by RFC3339.
- candidate
Responder List<Property Map>Rules - List of responder rules that can be used to remediate this detector rule
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- details List<Property Map>
- Detailed information for a detector.
- detector String
- Detector for the rule
- detector
Rule StringId - The unique identifier of the detector rule.
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entities
Mappings List<Property Map> - Data source entities mapping for the detector rule
- lifecycle
Details 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.
- managed
List List<String>Types - List of managed list types related to this rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- resource
Type String - Resource type of the configuration to which the rule is applied
- service
Type String - Service type of the configuration to which the rule is applied
- state String
- The current lifecycle state of the resource
- time
Created String - The date and time the detector recipe was created Format defined by RFC3339.
- time
Updated String - The date and time the detector recipe was last updated Format defined by RFC3339.
DetectorRecipeEffectiveDetectorRuleCandidateResponderRule, DetectorRecipeEffectiveDetectorRuleCandidateResponderRuleArgs
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Id string
- OCID for detector recipe
- Is
Preferred bool - Is this the preferred state?
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Id string
- OCID for detector recipe
- Is
Preferred bool - Is this the preferred state?
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id String
- OCID for detector recipe
- is
Preferred Boolean - Is this the preferred state?
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id string
- OCID for detector recipe
- is
Preferred boolean - Is this the preferred state?
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id str
- OCID for detector recipe
- is_
preferred bool - Is this the preferred state?
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- id String
- OCID for detector recipe
- is
Preferred Boolean - Is this the preferred state?
DetectorRecipeEffectiveDetectorRuleDetail, DetectorRecipeEffectiveDetectorRuleDetailArgs
- Condition string
- The base condition resource.
- Configurations
List<Detector
Recipe Effective Detector Rule Detail Configuration> - List of detector rule configurations
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Entities
Mappings List<DetectorRecipe Effective Detector Rule Detail Entities Mapping> - Data source entities mapping for the detector rule
- Is
Configuration boolAllowed - Can the rule be configured?
- Is
Enabled bool - Enablement status for the rule
- Labels List<string>
- User-defined labels for a detector rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Risk
Level string - The risk level for the rule
- Condition string
- The base condition resource.
- Configurations
[]Detector
Recipe Effective Detector Rule Detail Configuration - List of detector rule configurations
- Data
Source stringId - The ID of the attached data source
- Description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- Entities
Mappings []DetectorRecipe Effective Detector Rule Detail Entities Mapping - Data source entities mapping for the detector rule
- Is
Configuration boolAllowed - Can the rule be configured?
- Is
Enabled bool - Enablement status for the rule
- Labels []string
- User-defined labels for a detector rule
- Recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- Risk
Level string - The risk level for the rule
- condition String
- The base condition resource.
- configurations
List<Detector
Recipe Effective Detector Rule Detail Configuration> - List of detector rule configurations
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- entities
Mappings List<DetectorRecipe Effective Detector Rule Detail Entities Mapping> - Data source entities mapping for the detector rule
- is
Configuration BooleanAllowed - Can the rule be configured?
- is
Enabled Boolean - Enablement status for the rule
- labels List<String>
- User-defined labels for a detector rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- risk
Level String - The risk level for the rule
- condition string
- The base condition resource.
- configurations
Detector
Recipe Effective Detector Rule Detail Configuration[] - List of detector rule configurations
- data
Source stringId - The ID of the attached data source
- description string
(Updatable) Detector recipe description.
Avoid entering confidential information.
- entities
Mappings DetectorRecipe Effective Detector Rule Detail Entities Mapping[] - Data source entities mapping for the detector rule
- is
Configuration booleanAllowed - Can the rule be configured?
- is
Enabled boolean - Enablement status for the rule
- labels string[]
- User-defined labels for a detector rule
- recommendation string
- Recommendation for DetectorRecipeDetectorRule resource
- risk
Level string - The risk level for the rule
- condition str
- The base condition resource.
- configurations
Sequence[cloudguard.
Detector Recipe Effective Detector Rule Detail Configuration] - List of detector rule configurations
- data_
source_ strid - The ID of the attached data source
- description str
(Updatable) Detector recipe description.
Avoid entering confidential information.
- entities_
mappings Sequence[cloudguard.Detector Recipe Effective Detector Rule Detail Entities Mapping] - Data source entities mapping for the detector rule
- is_
configuration_ boolallowed - Can the rule be configured?
- is_
enabled bool - Enablement status for the rule
- labels Sequence[str]
- User-defined labels for a detector rule
- recommendation str
- Recommendation for DetectorRecipeDetectorRule resource
- risk_
level str - The risk level for the rule
- condition String
- The base condition resource.
- configurations List<Property Map>
- List of detector rule configurations
- data
Source StringId - The ID of the attached data source
- description String
(Updatable) Detector recipe description.
Avoid entering confidential information.
- entities
Mappings List<Property Map> - Data source entities mapping for the detector rule
- is
Configuration BooleanAllowed - Can the rule be configured?
- is
Enabled Boolean - Enablement status for the rule
- labels List<String>
- User-defined labels for a detector rule
- recommendation String
- Recommendation for DetectorRecipeDetectorRule resource
- risk
Level String - The risk level for the rule
DetectorRecipeEffectiveDetectorRuleDetailConfiguration, DetectorRecipeEffectiveDetectorRuleDetailConfigurationArgs
- config_
key str - Unique identifier of the configuration
- data_
type str - Configuration data type
- name str
- Configuration name
- value str
- Configuration value
- values
Sequence[cloudguard.
Detector Recipe Effective Detector Rule Detail Configuration Value] - List of configuration values
DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue, DetectorRecipeEffectiveDetectorRuleDetailConfigurationValueArgs
- List
Type string - Configuration list item type (CUSTOM or MANAGED)
- Managed
List stringType - Type of content in the managed list
- Value string
- Configuration value
- List
Type string - Configuration list item type (CUSTOM or MANAGED)
- Managed
List stringType - Type of content in the managed list
- Value string
- Configuration value
- list
Type String - Configuration list item type (CUSTOM or MANAGED)
- managed
List StringType - Type of content in the managed list
- value String
- Configuration value
- list
Type string - Configuration list item type (CUSTOM or MANAGED)
- managed
List stringType - Type of content in the managed list
- value string
- Configuration value
- list_
type str - Configuration list item type (CUSTOM or MANAGED)
- managed_
list_ strtype - Type of content in the managed list
- value str
- Configuration value
- list
Type String - Configuration list item type (CUSTOM or MANAGED)
- managed
List StringType - Type of content in the managed list
- value String
- Configuration value
DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping, DetectorRecipeEffectiveDetectorRuleDetailEntitiesMappingArgs
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type string - Type of entity
- query
Field string - The entity value mapped to a data source query
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity_
type str - Type of entity
- query_
field str - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
DetectorRecipeEffectiveDetectorRuleEntitiesMapping, DetectorRecipeEffectiveDetectorRuleEntitiesMappingArgs
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- Display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- Entity
Type string - Type of entity
- Query
Field string - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
- display
Name string (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type string - Type of entity
- query
Field string - The entity value mapped to a data source query
- display_
name str (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity_
type str - Type of entity
- query_
field str - The entity value mapped to a data source query
- display
Name String (Updatable) Detector recipe display name.
Avoid entering confidential information.
- entity
Type String - Type of entity
- query
Field String - The entity value mapped to a data source query
Import
DetectorRecipes can be imported using the id
, e.g.
$ pulumi import oci:CloudGuard/detectorRecipe:DetectorRecipe test_detector_recipe "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.