Data Source: oci_cloud_guard_targets
This data source provides the list of Targets in Oracle Cloud Infrastructure Cloud Guard service.
Returns a list of targets (TargetCollection resource with page of TargetSummary resources) for the target identified by compartmentId. By default, only the target associated with the compartment is returned. Setting compartmentIdInSubtree to true returns the entire hierarchy of targets in subcompartments.
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 ListTargets 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 targets in compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Example Usage
data "oci_cloud_guard_targets" "test_targets" {
#Required
compartment_id = var.compartment_id
#Optional
access_level = var.target_access_level
compartment_id_in_subtree = var.target_compartment_id_in_subtree
display_name = var.target_display_name
is_non_security_zone_targets_only_query = var.target_is_non_security_zone_targets_only_query
state = var.target_state
}
Argument Reference
The following arguments are supported:
access_level
- (Optional) Valid values areRESTRICTED
andACCESSIBLE
. Default isRESTRICTED
. Setting this toACCESSIBLE
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 toRESTRICTED
permissions are checked and no partial results are displayed.compartment_id
- (Required) The OCID of the compartment in which to list resources.compartment_id_in_subtree
- (Optional) 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 ofaccessLevel
.display_name
- (Optional) A filter to return only resources that match the entire display name given.is_non_security_zone_targets_only_query
- (Optional) Default is false. When set to true, only the targets that would be deleted as part of security zone creation will be returned.state
- (Optional) The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.
Attributes Reference
The following attributes are exported:
target_collection
- The list of target_collection.
Target Reference
The following attributes are exported:
compartment_id
- Compartment OCID where the resource is createddefined_tags
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:{"foo-namespace.bar-key": "value"}
description
- The target descriptiondisplay_name
- Target display namefreeform_tags
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:{"bar-key": "value"}
Avoid entering confidential information.
id
- Unique identifier that can’t be changed after creationinherited_by_compartments
- List of inherited compartmentslifecyle_details
- A message describing the current lifecycle state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]recipe_count
- Total number of recipes attached to targetstate
- The current lifecycle state of the targetsystem_tags
- 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_details
- Details specific to the target type.security_zone_display_name
- The name of the security zone to associate with this compartment.security_zone_id
- The OCID of the security zone to associate with this compartmenttarget_resource_type
- Target type, determined by the type of resource for which the target was createdtarget_security_zone_recipes
- The list of security zone recipes to associate with this compartmentcompartment_id
- The OCID of the compartment that contains the recipedefined_tags
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:{"foo-namespace.bar-key": "value"}
description
- The recipe’s descriptiondisplay_name
- The recipe’s display namefreeform_tags
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:{"bar-key": "value"}
Avoid entering confidential information.
id
- Unique identifier that can’t be changed after creationlifecycle_details
- A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in theFailed
state.owner
- The owner of the recipesecurity_policies
- The list of security policy IDs that are included in the recipestate
- The current lifecycle state of the recipesystem_tags
- 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
- The time the recipe was created. An RFC3339 formatted datetime string.time_updated
- The time the recipe was last updated. An RFC3339 formatted datetime string.
target_detector_recipes
- List of detector recipes attached to targetcompartment_id
- Compartment OCID of the detector recipedescription
- Detector recipe description.detector
- Type of detectordetector_recipe_id
- Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is baseddetector_recipe_type
- Recipe type ( STANDARD, ENTERPRISE )detector_rules
- List of detector rules for the detector recipe - user inputdata_source_id
- The ID of the attached data sourcedescription
- Description for TargetDetectorRecipeDetectorRule resourcedetails
- Overriden settings of a detector rule in recipe attached to target.condition_groups
- Condition group corresponding to each compartmentcompartment_id
- Compartment OCID associated with conditioncondition
- The base condition resource.
configurations
- List of detector rule configurationsconfig_key
- Unique identifier of the configurationdata_type
- Configuration data typename
- Configuration namevalue
- Configuration valuevalues
- List of configuration valueslist_type
- Configuration list item type (CUSTOM or MANAGED)managed_list_type
- Type of content in the managed listvalue
- Configuration value
is_configuration_allowed
- Configuration allowed or notis_enabled
- Enablement state of the detector rulelabels
- User-defined labels for a detector rulerisk_level
- The risk level of the detector rule
detector
- Detector type for the ruledetector_rule_id
- The unique identifier of the detector ruledisplay_name
- Display name for TargetDetectorRecipeDetectorRule resourceentities_mappings
- Data source entities mapping for a detector ruledisplay_name
- Display name of the entityentity_type
- Type of entityquery_field
- The entity value mapped to a data source query
lifecycle_details
- 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
- List of managed list types related to this rulerecommendation
- Recommendation for TargetDetectorRecipeDetectorRule resourceresource_type
- The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see Detector Recipe Reference.Or try Detector Recipe Reference.
service_type
- Service type of the configuration to which the rule is appliedstate
- The current lifecycle state of the detector ruletime_created
- The date and time the target detector recipe rule was created. Format defined by RFC3339.time_updated
- The date and time the target detector recipe rule was last updated. Format defined by RFC3339.
display_name
- Display name of the detector recipeeffective_detector_rules
- List of currently enabled detector rules for the detector type for recipe after applying defaultsdata_source_id
- The ID of the attached data sourcedescription
- Description for TargetDetectorRecipeDetectorRule resourcedetails
- Overriden settings of a detector rule in recipe attached to target.condition_groups
- Condition group corresponding to each compartmentcompartment_id
- Compartment OCID associated with conditioncondition
- The base condition resource.
configurations
- List of detector rule configurationsconfig_key
- Unique identifier of the configurationdata_type
- Configuration data typename
- Configuration namevalue
- Configuration valuevalues
- List of configuration valueslist_type
- Configuration list item type (CUSTOM or MANAGED)managed_list_type
- Type of content in the managed listvalue
- Configuration value
is_configuration_allowed
- Configuration allowed or notis_enabled
- Enablement state of the detector rulelabels
- User-defined labels for a detector rulerisk_level
- The risk level of the detector rule
detector
- Detector type for the ruledetector_rule_id
- The unique identifier of the detector ruledisplay_name
- Display name for TargetDetectorRecipeDetectorRule resourceentities_mappings
- Data source entities mapping for a detector ruledisplay_name
- Display name of the entityentity_type
- Type of entityquery_field
- The entity value mapped to a data source query
lifecycle_details
- 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
- List of managed list types related to this rulerecommendation
- Recommendation for TargetDetectorRecipeDetectorRule resourceresource_type
- The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see Detector Recipe Reference.Or try Detector Recipe Reference.
service_type
- Service type of the configuration to which the rule is appliedstate
- The current lifecycle state of the detector ruletime_created
- The date and time the target detector recipe rule was created. Format defined by RFC3339.time_updated
- The date and time the target detector recipe rule was last updated. Format defined by RFC3339.
id
- OCID for the detector recipeowner
- Owner of the detector recipestate
- The current lifecycle state of the resourcetime_created
- The date and time the target detector recipe was created. Format defined by RFC3339.time_updated
- The date and time the target detector recipe was last updated. Format defined by RFC3339.
target_resource_id
- Resource ID which the target uses to monitortarget_resource_type
- Type of targettarget_responder_recipes
- List of responder recipes attached to targetcompartment_id
- Compartment OCIDdescription
- Target responder descriptiondisplay_name
- Target responder recipe display nameeffective_responder_rules
- List of currently enabled responder rules for the responder type for recipe after applying defaultscompartment_id
- Compartment OCIDdescription
- Responder rule descriptiondetails
- Detailed information for a responder rulecondition
- The base condition resource.configurations
- List of responder rule configurationsconfig_key
- Unique identifier of the configurationname
- Configuration namevalue
- Configuration value
is_enabled
- Enabled state for the responder rulemode
- Execution mode for the responder rule
display_name
- Responder rule display namelifecycle_details
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.policies
- List of policiesresponder_rule_id
- Unique identifier for the responder rulestate
- The current lifecycle state of the responder rulesupported_modes
- Supported execution modes for the responder ruletime_created
- The date and time the target responder recipe rule was created. Format defined by RFC3339.time_updated
- The date and time the target responder recipe rule was last updated. Format defined by RFC3339.type
- Type of responder
id
- Unique identifier of target responder recipe that can’t be changed after creationowner
- Owner of target responder reciperesponder_recipe_id
- Unique identifier for the Oracle-managed responder recipe from which this recipe was clonedresponder_rules
- List of responder rules associated with the recipe - user inputcompartment_id
- Compartment OCIDdescription
- Responder rule descriptiondetails
- Detailed information for a responder rulecondition
- The base condition resource.configurations
- List of responder rule configurationsconfig_key
- Unique identifier of the configurationname
- Configuration namevalue
- Configuration value
is_enabled
- Enabled state for the responder rulemode
- Execution mode for the responder rule
display_name
- Responder rule display namelifecycle_details
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.policies
- List of policiesresponder_rule_id
- Unique identifier for the responder rulestate
- The current lifecycle state of the responder rulesupported_modes
- Supported execution modes for the responder ruletime_created
- The date and time the target responder recipe rule was created. Format defined by RFC3339.time_updated
- The date and time the target responder recipe rule was last updated. Format defined by RFC3339.type
- Type of responder
time_created
- The date and time the target responder recipe rule was created. Format defined by RFC3339.time_updated
- The date and time the target responder recipe rule was last updated. Format defined by RFC3339.
time_created
- The date and time the target was created. Format defined by RFC3339.time_updated
- The date and time the target was last updated. Format defined by RFC3339.