Skip to content

cloudguard.oracle.com/v1beta1

Back to API Reference

APIVersion: cloudguard.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes cloudguard.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
AdhocQuery Namespaced Sample -
DataMaskRule Namespaced Sample -
DataSource Namespaced Sample -
DetectorRecipe Namespaced Sample -
DetectorRecipeDetectorRule Namespaced Sample -
ManagedList Namespaced Sample -
ResponderRecipe Namespaced Sample -
SavedQuery Namespaced Sample -
SecurityRecipe Namespaced Sample -
SecurityZone Namespaced Sample -
Target Namespaced Sample -
TargetDetectorRecipe Namespaced Sample -
TargetResponderRecipe Namespaced Sample -
WlpAgent Namespaced Sample -

AdhocQuery

AdhocQuery is the Schema for the adhocqueries API.

  • Plural: adhocqueries
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_adhocquery.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

AdhocQuerySpec defines the desired state of AdhocQuery.

Field Description Type Required Default Enum
adhocQueryDetails AdhocQueryDetails defines nested fields for AdhocQuery.AdhocQueryDetails. object Yes - -
compartmentId Compartment OCID of adhoc query string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
freeformTags 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. map[string, string] No - -

Spec.adhocQueryDetails

Back to AdhocQuery spec

AdhocQueryDetails defines nested fields for AdhocQuery.AdhocQueryDetails.

Field Description Type Required Default Enum
adhocQueryResources Target information in which adhoc query will be run list[object] Yes - -
query The adhoc query expression that is run string Yes - -

Spec.adhocQueryDetails.adhocQueryResources[]

Back to AdhocQuery spec

AdhocQueryDetailsAdhocQueryResource defines nested fields for AdhocQuery.AdhocQueryDetails.AdhocQueryResource.

Field Description Type Required Default Enum
region Region in which adhoc query needs to be run string No - -
resourceIds List of OCIDs on which query needs to be run list[string] No - -
resourceType Type of resource string No - -

Status

AdhocQueryStatus defines the observed state of AdhocQuery.

Field Description Type Required Default Enum
adhocQueryDetails AdhocQueryDetails defines nested fields for AdhocQuery.AdhocQueryDetails. object No - -
adhocQueryRegionalDetails Instance level status for each region list[object] No - -
compartmentId Compartment OCID of the adhoc query string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
errorMessage Error message to show on UI in case of failure string No - -
freeformTags 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. map[string, string] No - -
id OCID for the adhoc query string No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state. string No - -
lifecycleState The current lifecycle state of the resource. string No - -
locks Locks associated with this resource. list[object] No - -
sdkStatus Status of the adhoc query This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the adhoc query was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the adhoc query was updated. Format defined by RFC3339. string No - -

Status.adhocQueryDetails

Back to AdhocQuery status

AdhocQueryDetails defines nested fields for AdhocQuery.AdhocQueryDetails.

Field Description Type Required Default Enum
adhocQueryResources Target information in which adhoc query will be run list[object] Yes - -
query The adhoc query expression that is run string Yes - -

Status.adhocQueryDetails.adhocQueryResources[]

Back to AdhocQuery status

AdhocQueryDetailsAdhocQueryResource defines nested fields for AdhocQuery.AdhocQueryDetails.AdhocQueryResource.

Field Description Type Required Default Enum
region Region in which adhoc query needs to be run string No - -
resourceIds List of OCIDs on which query needs to be run list[string] No - -
resourceType Type of resource string No - -

Status.adhocQueryRegionalDetails[]

Back to AdhocQuery status

AdhocQueryRegionalDetail defines nested fields for AdhocQuery.AdhocQueryRegionalDetail.

Field Description Type Required Default Enum
expectedCount Expected number of instances on which query should run string No - -
expiredCount Number of instances on which query expired string No - -
failedCount Number of instances on which query failed string No - -
region Region name string No - -
regionalError error message to show if adhoc query fails in a region string No - -
regionalStatus adhoc query status of the region string No - -
succeededCount Number of instances on which query succeeded string No - -

Status.locks[]

Back to AdhocQuery status

AdhocQueryLock defines nested fields for AdhocQuery.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.status

Back to AdhocQuery status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to AdhocQuery status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to AdhocQuery status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to AdhocQuery status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

DataMaskRule

DataMaskRule is the Schema for the datamaskrules API.

  • Plural: datamaskrules
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_datamaskrule.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DataMaskRuleSpec defines the desired state of DataMaskRule.

Field Description Type Required Default Enum
compartmentId Compartment OCID where the resource is created string Yes - -
dataMaskCategories Data mask rule categories list[string] Yes - -
dataMaskRuleStatus The current status of the data mask rule string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The data mask rule description Avoid entering confidential information. string No - -
displayName Data mask rule display name Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
iamGroupId IAM group ID associated with the data mask rule string Yes - -
lifecycleState The current lifecycle state of the data mask rule string No - -
targetSelected DataMaskRuleTargetSelected defines nested fields for DataMaskRule.TargetSelected. object Yes - -

Spec.targetSelected

Back to DataMaskRule spec

DataMaskRuleTargetSelected defines nested fields for DataMaskRule.TargetSelected.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
values Types of targets list[string] No - -

Status

DataMaskRuleStatus defines the observed state of DataMaskRule.

Field Description Type Required Default Enum
compartmentId Compartment OCID where the resource is created string No - -
dataMaskCategories List of data mask rule categories list[string] No - -
dataMaskRuleStatus The current status of the data mask rule string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The data mask rule description string No - -
displayName Data mask rule display name string No - -
freeformTags 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. map[string, string] No - -
iamGroupId IAM Group ID associated with the data mask rule string No - -
id Unique identifier that can't be changed after creation string No - -
lifecycleState The current lifecycle state of the data mask rule string No - -
lifecyleDetails Additional details on the substate of the lifecycle state [DEPRECATE] string No - -
locks Locks associated with this resource. list[object] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
targetSelected DataMaskRuleTargetSelected defines nested fields for DataMaskRule.TargetSelected. object No - -
timeCreated The date and time the target was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target was updated. Format defined by RFC3339. string No - -

Status.locks[]

Back to DataMaskRule status

DataMaskRuleLock defines nested fields for DataMaskRule.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.status

Back to DataMaskRule status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DataMaskRule status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DataMaskRule status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DataMaskRule status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.targetSelected

Back to DataMaskRule status

DataMaskRuleTargetSelected defines nested fields for DataMaskRule.TargetSelected.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
values Types of targets list[string] No - -

DataSource

DataSource is the Schema for the datasources API.

  • Plural: datasources
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_datasource.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DataSourceSpec defines the desired state of DataSource.

Field Description Type Required Default Enum
compartmentId Compartment OCID of the data source string Yes - -
dataSourceDetails DataSourceDetails defines nested fields for DataSource.DataSourceDetails. object No - -
dataSourceFeedProvider Type of data source feed provider (LoggingQuery) string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Data source display name string Yes - -
freeformTags 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. map[string, string] No - -
status Enablement status of data source. string No - -

Spec.dataSourceDetails

Back to DataSource spec

DataSourceDetails defines nested fields for DataSource.DataSourceDetails.

Field Description Type Required Default Enum
additionalEntitiesCount The additional entities count used for data source query integer No - -
dataSourceFeedProvider - string No - -
description Description text for the query string No - -
intervalInMinutes Interval in minutes that query is run periodically. integer No - -
intervalInSeconds Interval in minutes which query is run periodically. integer No - -
jsonData - string No - -
loggingQueryDetails DataSourceDetailsLoggingQueryDetails defines nested fields for DataSource.DataSourceDetails.LoggingQueryDetails. object No - -
loggingQueryType Type of logging query for data source (Sighting/Insight) string No - -
operator Operator used in data source string No - -
query The continuous query expression that is run periodically. string No - -
queryStartTime DataSourceDetailsQueryStartTime defines nested fields for DataSource.DataSourceDetails.QueryStartTime. object No - -
regions List of logging query regions list[string] No - -
scheduledQueryScopeDetails Target information in which scheduled query will be run list[object] No - -
threshold The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event integer No - -

Spec.dataSourceDetails.loggingQueryDetails

Back to DataSource spec

DataSourceDetailsLoggingQueryDetails defines nested fields for DataSource.DataSourceDetails.LoggingQueryDetails.

Field Description Type Required Default Enum
jsonData - string No - -
keyEntitiesCount The key entities count used for data source query integer No - -
loggingQueryType - string No - -

Spec.dataSourceDetails.queryStartTime

Back to DataSource spec

DataSourceDetailsQueryStartTime defines nested fields for DataSource.DataSourceDetails.QueryStartTime.

Field Description Type Required Default Enum
jsonData - string No - -
queryStartTime Time when the query can start. If not specified it can start immediately string No - -
startPolicyType - string No - -

Spec.dataSourceDetails.scheduledQueryScopeDetails[]

Back to DataSource spec

DataSourceDetailsScheduledQueryScopeDetail defines nested fields for DataSource.DataSourceDetails.ScheduledQueryScopeDetail.

Field Description Type Required Default Enum
region region on which scheduled query needs to be run string No - -
resourceIds List of OCIDs on scheduled query needs to run list[string] No - -
resourceType Type of resource string No - -

Status

DataSourceStatus defines the observed state of DataSource.

Field Description Type Required Default Enum
compartmentId Compartment OCID of data source string No - -
dataSourceDetails DataSourceDetails defines nested fields for DataSource.DataSourceDetails. object No - -
dataSourceDetectorMappingInfo Information about the detector recipe and rule attached list[object] No - -
dataSourceFeedProvider Possible type of dataSourceFeed Provider(LoggingQuery) string No - -
dataSourceSummaryDetails DataSourceSummaryDetails defines nested fields for DataSource.DataSourceSummaryDetails. object No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Display name of the data source string No - -
freeformTags 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. map[string, string] No - -
id OCID for the data source string No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state. string No - -
lifecycleState The current lifecycle state of the resource. string No - -
locks Locks associated with this resource. list[object] No - -
loggingQueryDetails DataSourceLoggingQueryDetails defines nested fields for DataSource.LoggingQueryDetails. object No - -
regionStatusDetail Information about the region and status of query replication list[object] No - -
sdkStatus Enablement status of the data source This uses a distinct JSON name so it can coexist with the OSOK status envelope. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the Data source was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the data source was updated. Format defined by RFC3339. string No - -

Status.dataSourceDetails

Back to DataSource status

DataSourceDetails defines nested fields for DataSource.DataSourceDetails.

Field Description Type Required Default Enum
additionalEntitiesCount The additional entities count used for data source query integer No - -
dataSourceFeedProvider - string No - -
description Description text for the query string No - -
intervalInMinutes Interval in minutes that query is run periodically. integer No - -
intervalInSeconds Interval in minutes which query is run periodically. integer No - -
jsonData - string No - -
loggingQueryDetails DataSourceDetailsLoggingQueryDetails defines nested fields for DataSource.DataSourceDetails.LoggingQueryDetails. object No - -
loggingQueryType Type of logging query for data source (Sighting/Insight) string No - -
operator Operator used in data source string No - -
query The continuous query expression that is run periodically. string No - -
queryStartTime DataSourceDetailsQueryStartTime defines nested fields for DataSource.DataSourceDetails.QueryStartTime. object No - -
regions List of logging query regions list[string] No - -
scheduledQueryScopeDetails Target information in which scheduled query will be run list[object] No - -
threshold The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event integer No - -

Status.dataSourceDetails.loggingQueryDetails

Back to DataSource status

DataSourceDetailsLoggingQueryDetails defines nested fields for DataSource.DataSourceDetails.LoggingQueryDetails.

Field Description Type Required Default Enum
jsonData - string No - -
keyEntitiesCount The key entities count used for data source query integer No - -
loggingQueryType - string No - -

Status.dataSourceDetails.queryStartTime

Back to DataSource status

DataSourceDetailsQueryStartTime defines nested fields for DataSource.DataSourceDetails.QueryStartTime.

Field Description Type Required Default Enum
jsonData - string No - -
queryStartTime Time when the query can start. If not specified it can start immediately string No - -
startPolicyType - string No - -

Status.dataSourceDetails.scheduledQueryScopeDetails[]

Back to DataSource status

DataSourceDetailsScheduledQueryScopeDetail defines nested fields for DataSource.DataSourceDetails.ScheduledQueryScopeDetail.

Field Description Type Required Default Enum
region region on which scheduled query needs to be run string No - -
resourceIds List of OCIDs on scheduled query needs to run list[string] No - -
resourceType Type of resource string No - -

Status.dataSourceDetectorMappingInfo[]

Back to DataSource status

DataSourceDetectorMappingInfo defines nested fields for DataSource.DataSourceDetectorMappingInfo.

Field Description Type Required Default Enum
detectorRecipeId ID of the detector recipe attached to the data source string No - -
detectorRuleId ID of the detector rule attached to the data source string No - -

Status.dataSourceSummaryDetails

Back to DataSource status

DataSourceSummaryDetails defines nested fields for DataSource.DataSourceSummaryDetails.

Field Description Type Required Default Enum
dataSourceDetectorMappingInfo Data source mapping with detector recipe and detector rule list[object] No - -
dataSourceFeedProvider - string No - -
description Description for the scheduled query string No - -
intervalInSeconds Interval in minutes in which the query is run periodically. integer No - -
jsonData - string No - -
regionStatusDetail DataSource query metadata replication region and status. list[object] No - -
regions Data source customer-specified regions list[string] No - -
scheduledQueryScopeDetails Target information in which scheduled query will be run list[object] No - -

Status.dataSourceSummaryDetails.dataSourceDetectorMappingInfo[]

Back to DataSource status

DataSourceSummaryDetailsDataSourceDetectorMappingInfo defines nested fields for DataSource.DataSourceSummaryDetails.DataSourceDetectorMappingInfo.

Field Description Type Required Default Enum
detectorRecipeId ID of the detector recipe attached to the data source string No - -
detectorRuleId ID of the detector rule attached to the data source string No - -

Status.dataSourceSummaryDetails.regionStatusDetail[]

Back to DataSource status

DataSourceSummaryDetailsRegionStatusDetail defines nested fields for DataSource.DataSourceSummaryDetails.RegionStatusDetail.

Field Description Type Required Default Enum
region Data source replication region string No - -
status Data source replication region status string No - -

Status.dataSourceSummaryDetails.scheduledQueryScopeDetails[]

Back to DataSource status

DataSourceSummaryDetailsScheduledQueryScopeDetail defines nested fields for DataSource.DataSourceSummaryDetails.ScheduledQueryScopeDetail.

Field Description Type Required Default Enum
region region on which scheduled query needs to be run string No - -
resourceIds List of OCIDs on scheduled query needs to run list[string] No - -
resourceType Type of resource string No - -

Status.locks[]

Back to DataSource status

DataSourceLock defines nested fields for DataSource.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.loggingQueryDetails

Back to DataSource status

DataSourceLoggingQueryDetails defines nested fields for DataSource.LoggingQueryDetails.

Field Description Type Required Default Enum
jsonData - string No - -
keyEntitiesCount The key entities count used for data source query integer No - -
loggingQueryType - string No - -

Status.regionStatusDetail[]

Back to DataSource status

DataSourceRegionStatusDetail defines nested fields for DataSource.RegionStatusDetail.

Field Description Type Required Default Enum
region Data source replication region string No - -
status Data source replication region status string No - -

Status.status

Back to DataSource status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DataSource status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DataSource status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DataSource status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

DetectorRecipe

DetectorRecipe is the Schema for the detectorrecipes API.

  • Plural: detectorrecipes
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_detectorrecipe.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DetectorRecipeSpec defines the desired state of DetectorRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Detector recipe description. Avoid entering confidential information. string No - -
detector Detector for the rule string No - -
detectorRules Detector rules to override from source detector recipe list[object] No - -
displayName Detector recipe display name. Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
sourceDetectorRecipeId The ID of the source detector recipe string No - -

Spec.detectorRules[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleFields defines nested fields for DetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details DetectorRecipeDetectorRuleDetails defines nested fields for DetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Detector recipe rule ID string Yes - -

Spec.detectorRules[].details

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetails defines nested fields for DetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
condition DetectorRecipeDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.DetectorRule.Details.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId The unique identifier of the attached data source string No - -
description Description for the detector rule string No - -
entitiesMappings Data source entities mapping for a detector rule list[object] No - -
isEnabled Enablement status of the detector rule boolean Yes - -
labels User-defined labels for a detector rule list[string] No - -
recommendation Recommendation for the detector rule string No - -
riskLevel The risk level of the detector rule string No - -

Spec.detectorRules[].details.condition

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.DetectorRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Spec.detectorRules[].details.configurations[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsConfiguration defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string Yes - -
dataType Configuration data type string No - -
name Configuration name string Yes - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Spec.detectorRules[].details.configurations[].additionalProperties[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Spec.detectorRules[].details.configurations[].allowedValues[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string Yes - -
value value string Yes - -

Spec.detectorRules[].details.configurations[].values[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsConfigurationValue defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string Yes - -
managedListType Type of content in the managed list string Yes - -
value Configuration value string Yes - -

Spec.detectorRules[].details.entitiesMappings[]

Back to DetectorRecipe spec

DetectorRecipeDetectorRuleDetailsEntitiesMapping defines nested fields for DetectorRecipe.DetectorRule.Details.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string Yes - -

Status

DetectorRecipeStatus defines the observed state of DetectorRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID of detector recipe string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Detector recipe description string No - -
detector Type of detector string No - -
detectorRecipeType Recipe type ( STANDARD, ENTERPRISE ) string No - -
detectorRules List of detector rules for the detector type for recipe - user input list[object] No - -
displayName Display name of detector recipe string No - -
effectiveDetectorRules List of effective detector rules for the detector type for recipe after applying defaults list[object] No - -
freeformTags 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. map[string, string] No - -
id OCID for detector recipe string No - -
lifecycleState The current lifecycle state of the resource string No - -
owner Owner of detector recipe string No - -
sourceDataRetention The number of days for which source data is retained integer No - -
sourceDetectorRecipeId Recipe OCID of the source recipe to be cloned string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
targetIds List of target IDs to which the recipe is attached list[string] No - -
timeCreated The date and time the detector recipe was created Format defined by RFC3339. string No - -
timeUpdated The date and time the detector recipe was last updated Format defined by RFC3339. string No - -

Status.detectorRules[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleFields defines nested fields for DetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details DetectorRecipeDetectorRuleDetails defines nested fields for DetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Detector recipe rule ID string Yes - -

Status.detectorRules[].details

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetails defines nested fields for DetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
condition DetectorRecipeDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.DetectorRule.Details.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId The unique identifier of the attached data source string No - -
description Description for the detector rule string No - -
entitiesMappings Data source entities mapping for a detector rule list[object] No - -
isEnabled Enablement status of the detector rule boolean Yes - -
labels User-defined labels for a detector rule list[string] No - -
recommendation Recommendation for the detector rule string No - -
riskLevel The risk level of the detector rule string No - -

Status.detectorRules[].details.condition

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.DetectorRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.detectorRules[].details.configurations[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsConfiguration defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string Yes - -
dataType Configuration data type string No - -
name Configuration name string Yes - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Status.detectorRules[].details.configurations[].additionalProperties[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Status.detectorRules[].details.configurations[].allowedValues[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string Yes - -
value value string Yes - -

Status.detectorRules[].details.configurations[].values[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsConfigurationValue defines nested fields for DetectorRecipe.DetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string Yes - -
managedListType Type of content in the managed list string Yes - -
value Configuration value string Yes - -

Status.detectorRules[].details.entitiesMappings[]

Back to DetectorRecipe status

DetectorRecipeDetectorRuleDetailsEntitiesMapping defines nested fields for DetectorRecipe.DetectorRule.Details.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string Yes - -

Status.effectiveDetectorRules[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRule defines nested fields for DetectorRecipe.EffectiveDetectorRule.

Field Description Type Required Default Enum
candidateResponderRules List of responder rules that can be used to remediate this detector rule list[object] No - -
dataSourceId The unique identifier of the attached data source string No - -
description Description for DetectorRecipeDetectorRule resource string No - -
details DetectorRecipeEffectiveDetectorRuleDetails defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details. object No - -
detector Detector recipe for the rule string No - -
detectorRuleId The unique identifier of the detector rule. string No - -
displayName Display name for DetectorRecipeDetectorRule resource string No - -
entitiesMappings Data source entities mapping for the detector rule list[object] No - -
isCloneable Is the rule cloneable? boolean No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the detector rule. string No - -
locks Locks associated with this resource. list[object] No - -
managedListTypes List of managed list types related to this rule list[string] No - -
recommendation Recommendation for DetectorRecipeDetectorRule resource string No - -
resourceType Resource type of the configuration to which the rule is applied string No - -
ruleType Detector rule type list[object] No - -
serviceType Service type of the configuration to which the rule is applied string No - -
timeCreated The date and time the detector recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the detector recipe rule was last updated. Format defined by RFC3339. string No - -

Status.effectiveDetectorRules[].candidateResponderRules[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleCandidateResponderRule defines nested fields for DetectorRecipe.EffectiveDetectorRule.CandidateResponderRule.

Field Description Type Required Default Enum
displayName The display name of the responder rule string No - -
id The unique identifier of the responder rule string No - -
isPreferred Is this the preferred state? boolean No - -

Status.effectiveDetectorRules[].details

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetails defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.

Field Description Type Required Default Enum
condition DetectorRecipeEffectiveDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId The ID of the attached data source string No - -
description Description for detector recipe detector rule string No - -
entitiesMappings Data source entities mapping for a detector rule list[object] No - -
isConfigurationAllowed Can the rule be configured? boolean No - -
isEnabled Enablement status for the rule boolean No - -
labels User-defined labels for a detector rule list[string] No - -
problemThreshold The point at which an elevated resource risk score creates a problem integer No - -
recommendation Recommendation for detector recipe detector rule string No - -
riskLevel The risk level for the rule string No - -
sightingTypes List of sighting types list[object] No - -
targetTypes List of target types for which the detector rule is applicable list[string] No - -

Status.effectiveDetectorRules[].details.condition

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsCondition defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.effectiveDetectorRules[].details.configurations[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsConfiguration defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string No - -
dataType Configuration data type string No - -
name Configuration name string No - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Status.effectiveDetectorRules[].details.configurations[].additionalProperties[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsConfigurationAdditionalProperty defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Status.effectiveDetectorRules[].details.configurations[].allowedValues[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsConfigurationAllowedValue defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string No - -
value value string No - -

Status.effectiveDetectorRules[].details.configurations[].values[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsConfigurationValue defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string No - -
managedListType Type of content in the managed list string No - -
value Configuration value string No - -

Status.effectiveDetectorRules[].details.entitiesMappings[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsEntitiesMapping defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string No - -

Status.effectiveDetectorRules[].details.sightingTypes[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleDetailsSightingType defines nested fields for DetectorRecipe.EffectiveDetectorRule.Details.SightingType.

Field Description Type Required Default Enum
description Description of the sighting type string No - -
displayName Display name of the sighting type string No - -
id The unique identifier of the sighting type string No - -
mitreLink MITRE ATT@CK framework link for the sighting type string No - -
tactic MITRE ATT@CK framework tactic for the sighting type string No - -
techniques List of MITRE ATT@CK framework techniques for the sighting type list[string] No - -

Status.effectiveDetectorRules[].entitiesMappings[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleEntitiesMapping defines nested fields for DetectorRecipe.EffectiveDetectorRule.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string No - -

Status.effectiveDetectorRules[].locks[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleLock defines nested fields for DetectorRecipe.EffectiveDetectorRule.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.effectiveDetectorRules[].ruleType[]

Back to DetectorRecipe status

DetectorRecipeEffectiveDetectorRuleRuleType defines nested fields for DetectorRecipe.EffectiveDetectorRule.RuleType.

Field Description Type Required Default Enum
key The unique identifier of the detector rule type string No - -
value Detector rule type value list[string] No - -

Status.status

Back to DetectorRecipe status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DetectorRecipe status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DetectorRecipe status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DetectorRecipe status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

DetectorRecipeDetectorRule

DetectorRecipeDetectorRule is the Schema for the detectorrecipedetectorrules API.

  • Plural: detectorrecipedetectorrules
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_detectorrecipedetectorrule.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

DetectorRecipeDetectorRuleSpec defines the desired state of DetectorRecipeDetectorRule.

Field Description Type Required Default Enum
details DetectorRecipeDetectorRuleDetailsFields defines nested fields for DetectorRecipeDetectorRule.Details. object No - -

Spec.details

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsFields defines nested fields for DetectorRecipeDetectorRule.Details.

Field Description Type Required Default Enum
condition DetectorRecipeDetectorRuleDetailsConditionFields defines nested fields for DetectorRecipeDetectorRule.Details.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId OCID of the data source which is attached string No - -
description Description of the detector rule string No - -
entitiesMappings Data source entities mapping for the detector rule list[object] No - -
isEnabled Enablement state of the detector rule boolean No - -
labels User-defined labels for the detector rule list[string] No - -
name Name of the detector rule string Yes - -
recommendation Recommendations for the detector rule string No - -
riskLevel The risk level for the detector rule string No - -
sourceDetectorRuleId ID of source detector rule string No - -

Spec.details.condition

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsConditionFields defines nested fields for DetectorRecipeDetectorRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Spec.details.configurations[]

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsConfigurationFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string Yes - -
dataType Configuration data type string No - -
name Configuration name string Yes - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Spec.details.configurations[].additionalProperties[]

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsConfigurationAdditionalPropertyFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Spec.details.configurations[].allowedValues[]

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsConfigurationAllowedValueFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string Yes - -
value value string Yes - -

Spec.details.configurations[].values[]

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsConfigurationValueFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string Yes - -
managedListType Type of content in the managed list string Yes - -
value Configuration value string Yes - -

Spec.details.entitiesMappings[]

Back to DetectorRecipeDetectorRule spec

DetectorRecipeDetectorRuleDetailsEntitiesMappingFields defines nested fields for DetectorRecipeDetectorRule.Details.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string Yes - -

Status

DetectorRecipeDetectorRuleStatus defines the observed state of DetectorRecipeDetectorRule.

Field Description Type Required Default Enum
candidateResponderRules List of responder rules that can be used to remediate this detector rule list[object] No - -
dataSourceId The unique identifier of the attached data source string No - -
description Description for DetectorRecipeDetectorRule resource string No - -
details DetectorRecipeDetectorRuleDetailsFields defines nested fields for DetectorRecipeDetectorRule.Details. object No - -
detector Detector recipe for the rule string No - -
detectorDetails DetectorRecipeDetectorRuleDetectorDetails defines nested fields for DetectorRecipeDetectorRule.DetectorDetails. object No - -
detectorRuleId The unique identifier of the detector rule. string No - -
displayName Display name for DetectorRecipeDetectorRule resource string No - -
entitiesMappings Data source entities mapping for the detector rule list[object] No - -
id The unique identifier of the detector rule string No - -
isCloneable Is the rule cloneable? boolean No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the detector rule. string No - -
locks Locks associated with this resource. list[object] No - -
managedListTypes List of managed list types related to this rule list[string] No - -
recommendation Recommendation for DetectorRecipeDetectorRule resource string No - -
resourceType Resource type of the configuration to which the rule is applied string No - -
ruleType Detector rule type list[object] No - -
serviceType Service type of the configuration to which the rule is applied string No - -
status - object Yes - -
timeCreated The date and time the detector recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the detector recipe rule was last updated. Format defined by RFC3339. string No - -

Status.candidateResponderRules[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleCandidateResponderRuleFields defines nested fields for DetectorRecipeDetectorRule.CandidateResponderRule.

Field Description Type Required Default Enum
displayName The display name of the responder rule string No - -
id The unique identifier of the responder rule string No - -
isPreferred Is this the preferred state? boolean No - -

Status.details

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsFields defines nested fields for DetectorRecipeDetectorRule.Details.

Field Description Type Required Default Enum
condition DetectorRecipeDetectorRuleDetailsConditionFields defines nested fields for DetectorRecipeDetectorRule.Details.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId OCID of the data source which is attached string No - -
description Description of the detector rule string No - -
entitiesMappings Data source entities mapping for the detector rule list[object] No - -
isEnabled Enablement state of the detector rule boolean No - -
labels User-defined labels for the detector rule list[string] No - -
name Name of the detector rule string Yes - -
recommendation Recommendations for the detector rule string No - -
riskLevel The risk level for the detector rule string No - -
sourceDetectorRuleId ID of source detector rule string No - -

Status.details.condition

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsConditionFields defines nested fields for DetectorRecipeDetectorRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.details.configurations[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsConfigurationFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string Yes - -
dataType Configuration data type string No - -
name Configuration name string Yes - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Status.details.configurations[].additionalProperties[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsConfigurationAdditionalPropertyFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Status.details.configurations[].allowedValues[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsConfigurationAllowedValueFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string Yes - -
value value string Yes - -

Status.details.configurations[].values[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsConfigurationValueFields defines nested fields for DetectorRecipeDetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string Yes - -
managedListType Type of content in the managed list string Yes - -
value Configuration value string Yes - -

Status.details.entitiesMappings[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetailsEntitiesMappingFields defines nested fields for DetectorRecipeDetectorRule.Details.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string Yes - -

Status.detectorDetails

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetails defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.

Field Description Type Required Default Enum
condition DetectorRecipeDetectorRuleDetectorDetailsCondition defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Condition. object No - -
configurations List of detector rule configurations list[object] No - -
dataSourceId The ID of the attached data source string No - -
description Description for detector recipe detector rule string No - -
entitiesMappings Data source entities mapping for a detector rule list[object] No - -
isConfigurationAllowed Can the rule be configured? boolean No - -
isEnabled Enablement status for the rule boolean No - -
labels User-defined labels for a detector rule list[string] No - -
problemThreshold The point at which an elevated resource risk score creates a problem integer No - -
recommendation Recommendation for detector recipe detector rule string No - -
riskLevel The risk level for the rule string No - -
sightingTypes List of sighting types list[object] No - -
targetTypes List of target types for which the detector rule is applicable list[string] No - -

Status.detectorDetails.condition

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsCondition defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.detectorDetails.configurations[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsConfiguration defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string No - -
dataType Configuration data type string No - -
name Configuration name string No - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Status.detectorDetails.configurations[].additionalProperties[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsConfigurationAdditionalProperty defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Status.detectorDetails.configurations[].allowedValues[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsConfigurationAllowedValue defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string No - -
value value string No - -

Status.detectorDetails.configurations[].values[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsConfigurationValue defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string No - -
managedListType Type of content in the managed list string No - -
value Configuration value string No - -

Status.detectorDetails.entitiesMappings[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsEntitiesMapping defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string No - -

Status.detectorDetails.sightingTypes[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleDetectorDetailsSightingType defines nested fields for DetectorRecipeDetectorRule.DetectorDetails.SightingType.

Field Description Type Required Default Enum
description Description of the sighting type string No - -
displayName Display name of the sighting type string No - -
id The unique identifier of the sighting type string No - -
mitreLink MITRE ATT@CK framework link for the sighting type string No - -
tactic MITRE ATT@CK framework tactic for the sighting type string No - -
techniques List of MITRE ATT@CK framework techniques for the sighting type list[string] No - -

Status.entitiesMappings[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleEntitiesMappingFields defines nested fields for DetectorRecipeDetectorRule.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string No - -

Status.locks[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleLockFields defines nested fields for DetectorRecipeDetectorRule.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.ruleType[]

Back to DetectorRecipeDetectorRule status

DetectorRecipeDetectorRuleRuleTypeFields defines nested fields for DetectorRecipeDetectorRule.RuleType.

Field Description Type Required Default Enum
key The unique identifier of the detector rule type string No - -
value Detector rule type value list[string] No - -

Status.status

Back to DetectorRecipeDetectorRule status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to DetectorRecipeDetectorRule status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to DetectorRecipeDetectorRule status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to DetectorRecipeDetectorRule status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ManagedList

ManagedList is the Schema for the managedlists API.

  • Plural: managedlists
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_managedlist.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ManagedListSpec defines the desired state of ManagedList.

Field Description Type Required Default Enum
compartmentId Compartment OCID string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Managed list description Avoid entering confidential information. string No - -
displayName Managed list display name. Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
group Managed list type group string No - -
listItems List of items in the managed list list[string] No - -
listType Type of information stored in the list string No - -
sourceManagedListId OCID of the source managed list string No - -

Status

ManagedListStatus defines the observed state of ManagedList.

Field Description Type Required Default Enum
compartmentId Compartment OCID where the resource is created string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Managed list description string No - -
displayName Managed list display name string No - -
feedProvider Provider of the managed list feed string No - -
freeformTags 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. map[string, string] No - -
group Managed list type group string No - -
id Unique identifier that can't be changed after creation string No - -
isEditable Is this list editable? boolean No - -
lifecycleState The current lifecycle state of the resource string No - -
lifecyleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE] string No - -
listItems List of items in the managed list list[string] No - -
listType Type of information contained in the managed list string No - -
sourceManagedListId OCID of the source managed list string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the managed list was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the managed list was last updated. Format defined by RFC3339. string No - -

Status.status

Back to ManagedList status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ManagedList status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ManagedList status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ManagedList status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ResponderRecipe

ResponderRecipe is the Schema for the responderrecipes API.

  • Plural: responderrecipes
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_responderrecipe.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ResponderRecipeSpec defines the desired state of ResponderRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Responder recipe description. Avoid entering confidential information. string No - -
displayName Responder recipe display name. Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
responderRules List of responder rules to override from source responder recipe list[object] No - -
sourceResponderRecipeId The unique identifier of the source responder recipe string Yes - -

Spec.responderRules[]

Back to ResponderRecipe spec

ResponderRecipeResponderRule defines nested fields for ResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details ResponderRecipeResponderRuleDetails defines nested fields for ResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for the responder rule string Yes - -

Spec.responderRules[].details

Back to ResponderRecipe spec

ResponderRecipeResponderRuleDetails defines nested fields for ResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
isEnabled Enablement state for the responder rule boolean Yes - -

Status

ResponderRecipeStatus defines the observed state of ResponderRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Responder recipe description string No - -
displayName Responder recipe display name string No - -
effectiveResponderRules List of currently enabled responder rules for the responder type, for recipe after applying defaults list[object] No - -
freeformTags 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. map[string, string] No - -
id Unique identifier for the responder recip string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the example string No - -
owner Owner of responder recipe string No - -
responderRules List of responder rules associated with the recipe list[object] No - -
sourceResponderRecipeId The unique identifier of the source responder recipe string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the responder recipe was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the responder recipe was last updated. Format defined by RFC3339. string No - -

Status.effectiveResponderRules[]

Back to ResponderRecipe status

ResponderRecipeEffectiveResponderRule defines nested fields for ResponderRecipe.EffectiveResponderRule.

Field Description Type Required Default Enum
compartmentId Compartment OCID string No - -
description Responder rule description string No - -
details ResponderRecipeEffectiveResponderRuleDetails defines nested fields for ResponderRecipe.EffectiveResponderRule.Details. object No - -
displayName Responder rule display name string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the responder rule string No - -
locks Locks associated with this resource. list[object] No - -
policies List of policies list[string] No - -
responderRuleId Unique identifier for the responder rule string No - -
supportedModes Supported execution modes for the responder rule list[string] No - -
timeCreated The date and time the responder recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the responder recipe rule was last updated. Format defined by RFC3339. string No - -
type Type of responder string No - -

Status.effectiveResponderRules[].details

Back to ResponderRecipe status

ResponderRecipeEffectiveResponderRuleDetails defines nested fields for ResponderRecipe.EffectiveResponderRule.Details.

Field Description Type Required Default Enum
condition ResponderRecipeEffectiveResponderRuleDetailsCondition defines nested fields for ResponderRecipe.EffectiveResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
isEnabled Enabled state for the responder rule boolean No - -
mode Execution mode for the responder rule string No - -

Status.effectiveResponderRules[].details.condition

Back to ResponderRecipe status

ResponderRecipeEffectiveResponderRuleDetailsCondition defines nested fields for ResponderRecipe.EffectiveResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.effectiveResponderRules[].details.configurations[]

Back to ResponderRecipe status

ResponderRecipeEffectiveResponderRuleDetailsConfiguration defines nested fields for ResponderRecipe.EffectiveResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string No - -
name Configuration name string No - -
value Configuration value string No - -

Status.effectiveResponderRules[].locks[]

Back to ResponderRecipe status

ResponderRecipeEffectiveResponderRuleLock defines nested fields for ResponderRecipe.EffectiveResponderRule.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.responderRules[]

Back to ResponderRecipe status

ResponderRecipeResponderRule defines nested fields for ResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details ResponderRecipeResponderRuleDetails defines nested fields for ResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for the responder rule string Yes - -

Status.responderRules[].details

Back to ResponderRecipe status

ResponderRecipeResponderRuleDetails defines nested fields for ResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
isEnabled Enablement state for the responder rule boolean Yes - -

Status.status

Back to ResponderRecipe status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ResponderRecipe status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ResponderRecipe status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ResponderRecipe status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

SavedQuery

SavedQuery is the Schema for the savedqueries API.

  • Plural: savedqueries
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_savedquery.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SavedQuerySpec defines the desired state of SavedQuery.

Field Description Type Required Default Enum
compartmentId Compartment OCID of the saved query string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the saved query string No - -
displayName Display name of the saved query string Yes - -
freeformTags 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. map[string, string] No - -
query The adhoc query expression that is run string Yes - -

Status

SavedQueryStatus defines the observed state of SavedQuery.

Field Description Type Required Default Enum
compartmentId Compartment OCID of the saved query string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the saved query string No - -
displayName Display name of the saved query string No - -
freeformTags 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. map[string, string] No - -
id OCID for the saved query string No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state. string No - -
lifecycleState The current lifecycle state of the resource string No - -
locks Locks associated with this resource. list[object] No - -
query The saved query expression string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the saved query was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the saved query was updated. Format defined by RFC3339. string No - -

Status.locks[]

Back to SavedQuery status

SavedQueryLock defines nested fields for SavedQuery.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.status

Back to SavedQuery status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to SavedQuery status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to SavedQuery status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to SavedQuery status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

SecurityRecipe

SecurityRecipe is the Schema for the securityrecipes API.

  • Plural: securityrecipes
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_securityrecipe.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SecurityRecipeSpec defines the desired state of SecurityRecipe.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment in which to create the recipe string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The recipe's description string No - -
displayName The recipe's display name. Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
securityPolicies The list of security policy IDs to include in the recipe list[string] Yes - -

Status

SecurityRecipeStatus defines the observed state of SecurityRecipe.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that contains the recipe string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The recipe's description string No - -
displayName The recipe's display name string No - -
freeformTags 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. map[string, string] No - -
id Unique identifier that can’t be changed after creation string No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state. string No - -
lifecycleState The current lifecycle state of the recipe string No - -
owner The owner of the recipe string No - -
securityPolicies The list of security policy IDs that are included in the recipe list[string] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the recipe was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time the recipe was last updated. An RFC3339 formatted datetime string. string No - -

Status.status

Back to SecurityRecipe status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to SecurityRecipe status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to SecurityRecipe status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to SecurityRecipe status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

SecurityZone

SecurityZone is the Schema for the securityzones API.

  • Plural: securityzones
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_securityzone.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SecurityZoneSpec defines the desired state of SecurityZone.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the security zone string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The security zone's description string No - -
displayName The security zone's display name string Yes - -
freeformTags 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. map[string, string] No - -
securityZoneRecipeId The OCID of the security zone recipe (SecurityRecipe resource) for the security zone string Yes - -

Status

SecurityZoneStatus defines the observed state of SecurityZone.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment for the security zone string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The security zone's description string No - -
displayName The security zone's display name string No - -
freeformTags 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. map[string, string] No - -
id Unique identifier that can’t be changed after creation string No - -
inheritedByCompartments List of inherited compartments list[string] No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the Failed state. string No - -
lifecycleState The current lifecycle state of the security zone string No - -
securityZoneRecipeId The OCID of the recipe (SecurityRecipe resource) for the security zone string No - -
securityZoneTargetId The OCID of the target associated with the security zone string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the security zone was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time the security zone was last updated. An RFC3339 formatted datetime string. string No - -

Status.status

Back to SecurityZone status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to SecurityZone status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to SecurityZone status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to SecurityZone status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Target

Target is the Schema for the targets API.

  • Plural: targets
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_target.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TargetSpec defines the desired state of Target.

Field Description Type Required Default Enum
compartmentId Compartment OCID where the resource is created string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The target description. Avoid entering confidential information. string No - -
displayName Display name for the target. Avoid entering confidential information. string Yes - -
freeformTags 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. map[string, string] No - -
lifecycleState The enablement state of the detector rule string No - -
targetDetectorRecipes List of detector recipes to attach to target list[object] No - -
targetResourceId Resource ID which the target uses to monitor string Yes - -
targetResourceType Type of resource that target support (COMPARTMENT/FACLOUD) string Yes - -
targetResponderRecipes List of responder recipes to attach to target list[object] No - -

Spec.targetDetectorRecipes[]

Back to Target spec

TargetDetectorRecipeFields defines nested fields for Target.TargetDetectorRecipe.

Field Description Type Required Default Enum
detectorRecipeId Unique identifier for the target detector recipe string Yes - -
detectorRules List of overrides to be applied to detector rules associated with the target list[object] No - -

Spec.targetDetectorRecipes[].detectorRules[]

Back to Target spec

TargetDetectorRecipeDetectorRule defines nested fields for Target.TargetDetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details TargetDetectorRecipeDetectorRuleDetails defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Unique identifier for the detector rule string Yes - -

Spec.targetDetectorRecipes[].detectorRules[].details

Back to Target spec

TargetDetectorRecipeDetectorRuleDetails defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
conditionGroups Condition group corresponding to each compartment list[object] No - -

Spec.targetDetectorRecipes[].detectorRules[].details.conditionGroups[]

Back to Target spec

TargetDetectorRecipeDetectorRuleDetailsConditionGroup defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.

Field Description Type Required Default Enum
compartmentId Compartment OCID associated with condition string Yes - -
condition TargetDetectorRecipeDetectorRuleDetailsConditionGroupCondition defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition. object Yes - -

Spec.targetDetectorRecipes[].detectorRules[].details.conditionGroups[].condition

Back to Target spec

TargetDetectorRecipeDetectorRuleDetailsConditionGroupCondition defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Spec.targetResponderRecipes[]

Back to Target spec

TargetResponderRecipeFields defines nested fields for Target.TargetResponderRecipe.

Field Description Type Required Default Enum
responderRecipeId Unique identifier for responder recipe string Yes - -
responderRules List of overrides to be applied to responder rules associated with the target list[object] No - -

Spec.targetResponderRecipes[].responderRules[]

Back to Target spec

TargetResponderRecipeResponderRule defines nested fields for Target.TargetResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details TargetResponderRecipeResponderRuleDetails defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for target detector recipe string Yes - -

Spec.targetResponderRecipes[].responderRules[].details

Back to Target spec

TargetResponderRecipeResponderRuleDetails defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
condition TargetResponderRecipeResponderRuleDetailsCondition defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
mode Execution mode for the responder rule string No - -

Spec.targetResponderRecipes[].responderRules[].details.condition

Back to Target spec

TargetResponderRecipeResponderRuleDetailsCondition defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Spec.targetResponderRecipes[].responderRules[].details.configurations[]

Back to Target spec

TargetResponderRecipeResponderRuleDetailsConfiguration defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string Yes - -
name Configuration name string Yes - -
value Configuration value string Yes - -

Status

TargetStatus defines the observed state of Target.

Field Description Type Required Default Enum
compartmentId Compartment OCID where the resource is created string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The target description string No - -
displayName Target display name string No - -
freeformTags 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. map[string, string] No - -
id Unique identifier that can't be changed after creation string No - -
inheritedByCompartments List of inherited compartments list[string] No - -
lifecycleState The current lifecycle state of the target string No - -
lifecyleDetails 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] string No - -
recipeCount Total number of recipes attached to target integer No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
targetDetails TargetDetails defines nested fields for Target.TargetDetails. object No - -
targetDetectorRecipes List of detector recipes attached to target list[object] No - -
targetResourceId Resource ID which the target uses to monitor string No - -
targetResourceType Type of target string No - -
targetResponderRecipes List of responder recipes attached to target list[object] No - -
timeCreated The date and time the target was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target was last updated. Format defined by RFC3339. string No - -

Status.status

Back to Target status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Target status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Target status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Target status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.targetDetails

Back to Target status

TargetDetails defines nested fields for Target.TargetDetails.

Field Description Type Required Default Enum
jsonData - string No - -
securityZoneDisplayName The name of the security zone to associate with this compartment. string No - -
securityZoneId The OCID of the security zone to associate with this compartment string No - -
targetResourceType - string No - -
targetSecurityZoneRecipes The list of security zone recipes to associate with this compartment list[object] No - -

Status.targetDetails.targetSecurityZoneRecipes[]

Back to Target status

TargetDetailsTargetSecurityZoneRecipe defines nested fields for Target.TargetDetails.TargetSecurityZoneRecipe.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that contains the recipe string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The recipe's description string No - -
displayName The recipe's display name string No - -
freeformTags 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. map[string, string] No - -
id Unique identifier that can’t be changed after creation string No - -
lifecycleDetails A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state. string No - -
lifecycleState The current lifecycle state of the recipe string No - -
owner The owner of the recipe string No - -
securityPolicies The list of security policy IDs that are included in the recipe list[string] No - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the recipe was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time the recipe was last updated. An RFC3339 formatted datetime string. string No - -

Status.targetDetectorRecipes[]

Back to Target status

TargetDetectorRecipeFields defines nested fields for Target.TargetDetectorRecipe.

Field Description Type Required Default Enum
detectorRecipeId Unique identifier for the target detector recipe string Yes - -
detectorRules List of overrides to be applied to detector rules associated with the target list[object] No - -

Status.targetDetectorRecipes[].detectorRules[]

Back to Target status

TargetDetectorRecipeDetectorRule defines nested fields for Target.TargetDetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details TargetDetectorRecipeDetectorRuleDetails defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Unique identifier for the detector rule string Yes - -

Status.targetDetectorRecipes[].detectorRules[].details

Back to Target status

TargetDetectorRecipeDetectorRuleDetails defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
conditionGroups Condition group corresponding to each compartment list[object] No - -

Status.targetDetectorRecipes[].detectorRules[].details.conditionGroups[]

Back to Target status

TargetDetectorRecipeDetectorRuleDetailsConditionGroup defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.

Field Description Type Required Default Enum
compartmentId Compartment OCID associated with condition string Yes - -
condition TargetDetectorRecipeDetectorRuleDetailsConditionGroupCondition defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition. object Yes - -

Status.targetDetectorRecipes[].detectorRules[].details.conditionGroups[].condition

Back to Target status

TargetDetectorRecipeDetectorRuleDetailsConditionGroupCondition defines nested fields for Target.TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.targetResponderRecipes[]

Back to Target status

TargetResponderRecipeFields defines nested fields for Target.TargetResponderRecipe.

Field Description Type Required Default Enum
responderRecipeId Unique identifier for responder recipe string Yes - -
responderRules List of overrides to be applied to responder rules associated with the target list[object] No - -

Status.targetResponderRecipes[].responderRules[]

Back to Target status

TargetResponderRecipeResponderRule defines nested fields for Target.TargetResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details TargetResponderRecipeResponderRuleDetails defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for target detector recipe string Yes - -

Status.targetResponderRecipes[].responderRules[].details

Back to Target status

TargetResponderRecipeResponderRuleDetails defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
condition TargetResponderRecipeResponderRuleDetailsCondition defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
mode Execution mode for the responder rule string No - -

Status.targetResponderRecipes[].responderRules[].details.condition

Back to Target status

TargetResponderRecipeResponderRuleDetailsCondition defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.targetResponderRecipes[].responderRules[].details.configurations[]

Back to Target status

TargetResponderRecipeResponderRuleDetailsConfiguration defines nested fields for Target.TargetResponderRecipe.ResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string Yes - -
name Configuration name string Yes - -
value Configuration value string Yes - -

TargetDetectorRecipe

TargetDetectorRecipe is the Schema for the targetdetectorrecipes API.

  • Plural: targetdetectorrecipes
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_targetdetectorrecipe.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TargetDetectorRecipeSpec defines the desired state of TargetDetectorRecipe.

Field Description Type Required Default Enum
detectorRecipeId Unique identifier for the target detector recipe string Yes - -
detectorRules List of overrides to be applied to detector rules associated with the target list[object] No - -
isValidationOnlyQuery Is validation to be performed for attaching the detector recipe? boolean No - -

Spec.detectorRules[]

Back to TargetDetectorRecipe spec

TargetDetectorRecipeDetectorRuleFields defines nested fields for TargetDetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details TargetDetectorRecipeDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Unique identifier for the detector rule string Yes - -

Spec.detectorRules[].details

Back to TargetDetectorRecipe spec

TargetDetectorRecipeDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
conditionGroups Condition group corresponding to each compartment list[object] No - -

Spec.detectorRules[].details.conditionGroups[]

Back to TargetDetectorRecipe spec

TargetDetectorRecipeDetectorRuleDetailsConditionGroupFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.

Field Description Type Required Default Enum
compartmentId Compartment OCID associated with condition string Yes - -
condition TargetDetectorRecipeDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition. object Yes - -

Spec.detectorRules[].details.conditionGroups[].condition

Back to TargetDetectorRecipe spec

TargetDetectorRecipeDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status

TargetDetectorRecipeStatus defines the observed state of TargetDetectorRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID of the detector recipe string No - -
description Detector recipe description. string No - -
detector Type of detector string No - -
detectorRecipeId Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based string No - -
detectorRecipeType Recipe type ( STANDARD, ENTERPRISE ) string No - -
detectorRules List of detector rules for the detector recipe - user input list[object] No - -
displayName Display name of the detector recipe string No - -
effectiveDetectorRules List of currently enabled detector rules for the detector type for recipe after applying defaults list[object] No - -
id OCID for the detector recipe string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the resource string No - -
locks Locks associated with this resource. list[object] No - -
owner Owner of the detector recipe string No - -
sourceDataRetention The number of days for which source data is retained integer No - -
status - object Yes - -
timeCreated The date and time the target detector recipe was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target detector recipe was last updated. Format defined by RFC3339. string No - -

Status.detectorRules[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeDetectorRuleFields defines nested fields for TargetDetectorRecipe.DetectorRule.

Field Description Type Required Default Enum
details TargetDetectorRecipeDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details. object Yes - -
detectorRuleId Unique identifier for the detector rule string Yes - -

Status.detectorRules[].details

Back to TargetDetectorRecipe status

TargetDetectorRecipeDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.

Field Description Type Required Default Enum
conditionGroups Condition group corresponding to each compartment list[object] No - -

Status.detectorRules[].details.conditionGroups[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeDetectorRuleDetailsConditionGroupFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.

Field Description Type Required Default Enum
compartmentId Compartment OCID associated with condition string Yes - -
condition TargetDetectorRecipeDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition. object Yes - -

Status.detectorRules[].details.conditionGroups[].condition

Back to TargetDetectorRecipe status

TargetDetectorRecipeDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.DetectorRule.Details.ConditionGroup.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.effectiveDetectorRules[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.

Field Description Type Required Default Enum
dataSourceId The ID of the attached data source string No - -
description Description for TargetDetectorRecipeDetectorRule resource string No - -
details TargetDetectorRecipeEffectiveDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details. object No - -
detector Detector type for the rule string No - -
detectorRuleId The unique identifier of the detector rule string No - -
displayName Display name for TargetDetectorRecipeDetectorRule resource string No - -
entitiesMappings Data source entities mapping for a detector rule list[object] No - -
isCloneable Is the rule cloneable? boolean No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the detector rule string No - -
locks Locks associated with this resource. list[object] No - -
managedListTypes List of managed list types related to this rule list[string] No - -
recommendation Recommendation for TargetDetectorRecipeDetectorRule resource string No - -
resourceType 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 (https://docs.oracle.com/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference). Or try Detector Recipe Reference (https://docs.oracle.com/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference). string No - -
ruleType Rule category type list[object] No - -
serviceType Service type of the configuration to which the rule is applied string No - -
timeCreated The date and time the target detector recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target detector recipe rule was last updated. Format defined by RFC3339. string No - -

Status.effectiveDetectorRules[].details

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.

Field Description Type Required Default Enum
conditionGroups Condition group corresponding to each compartment list[object] No - -
configurations List of detector rule configurations list[object] No - -
isConfigurationAllowed Configuration allowed or not boolean No - -
isEnabled Enablement state of the detector rule boolean No - -
labels User-defined labels for a detector rule list[string] No - -
problemThreshold Point at which an elevated resource risk score creates a problem integer No - -
riskLevel The risk level of the detector rule string No - -
sightingTypes List of sighting types list[object] No - -
targetTypes List of target types for which the detector rule is applicable list[string] No - -

Status.effectiveDetectorRules[].details.conditionGroups[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConditionGroupFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.ConditionGroup.

Field Description Type Required Default Enum
compartmentId Compartment OCID associated with condition string No - -
condition TargetDetectorRecipeEffectiveDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.ConditionGroup.Condition. object No - -

Status.effectiveDetectorRules[].details.conditionGroups[].condition

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConditionGroupConditionFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.ConditionGroup.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.effectiveDetectorRules[].details.configurations[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConfigurationFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.Configuration.

Field Description Type Required Default Enum
additionalProperties Map of additional property values for configuration list[object] No - -
allowedValues Map of possible values for configuration list[object] No - -
allowedValuesDataType Map property Value data type string No - -
configKey Unique identifier of the configuration string No - -
dataType Configuration data type string No - -
name Configuration name string No - -
value Configuration value string No - -
values List of configuration values list[object] No - -

Status.effectiveDetectorRules[].details.configurations[].additionalProperties[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConfigurationAdditionalPropertyFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.Configuration.AdditionalProperty.

Field Description Type Required Default Enum
key Name for Additional Property, for example, "interpreter", "router" string No - -
propertyType Property Type string No - -
value Value for Property Name, for example, "generic", "cloudguard" string No - -

Status.effectiveDetectorRules[].details.configurations[].allowedValues[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConfigurationAllowedValueFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.Configuration.AllowedValue.

Field Description Type Required Default Enum
key key string No - -
value value string No - -

Status.effectiveDetectorRules[].details.configurations[].values[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsConfigurationValueFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.Configuration.Value.

Field Description Type Required Default Enum
listType Configuration list item type (CUSTOM or MANAGED) string No - -
managedListType Type of content in the managed list string No - -
value Configuration value string No - -

Status.effectiveDetectorRules[].details.sightingTypes[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleDetailsSightingTypeFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Details.SightingType.

Field Description Type Required Default Enum
description Description of the sighting type string No - -
displayName Display name of the sighting type string No - -
id The unique identifier of the sighting type string No - -
mitreLink MITRE ATT@CK framework link for the sighting type string No - -
tactic MITRE ATT@CK framework tactic for the sighting type string No - -
techniques List of MITRE ATT@CK framework techniques for the sighting type list[string] No - -

Status.effectiveDetectorRules[].entitiesMappings[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleEntitiesMappingFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.EntitiesMapping.

Field Description Type Required Default Enum
displayName Display name of the entity string No - -
entityType Type of entity string No - -
queryField The entity value mapped to a data source query string No - -

Status.effectiveDetectorRules[].locks[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleLockFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.effectiveDetectorRules[].ruleType[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeEffectiveDetectorRuleRuleTypeFields defines nested fields for TargetDetectorRecipe.EffectiveDetectorRule.RuleType.

Field Description Type Required Default Enum
key The unique identifier of the detector rule type string No - -
value Detector rule type value list[string] No - -

Status.locks[]

Back to TargetDetectorRecipe status

TargetDetectorRecipeLockFields defines nested fields for TargetDetectorRecipe.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.status

Back to TargetDetectorRecipe status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to TargetDetectorRecipe status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to TargetDetectorRecipe status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to TargetDetectorRecipe status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

TargetResponderRecipe

TargetResponderRecipe is the Schema for the targetresponderrecipes API.

  • Plural: targetresponderrecipes
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_targetresponderrecipe.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

TargetResponderRecipeSpec defines the desired state of TargetResponderRecipe.

Field Description Type Required Default Enum
responderRecipeId Unique identifier for responder recipe string Yes - -
responderRules List of overrides to be applied to responder rules associated with the target list[object] No - -

Spec.responderRules[]

Back to TargetResponderRecipe spec

TargetResponderRecipeResponderRuleFields defines nested fields for TargetResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details TargetResponderRecipeResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for target detector recipe string Yes - -

Spec.responderRules[].details

Back to TargetResponderRecipe spec

TargetResponderRecipeResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
condition TargetResponderRecipeResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
mode Execution mode for the responder rule string No - -

Spec.responderRules[].details.condition

Back to TargetResponderRecipe spec

TargetResponderRecipeResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Spec.responderRules[].details.configurations[]

Back to TargetResponderRecipe spec

TargetResponderRecipeResponderRuleDetailsConfigurationFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string Yes - -
name Configuration name string Yes - -
value Configuration value string Yes - -

Status

TargetResponderRecipeStatus defines the observed state of TargetResponderRecipe.

Field Description Type Required Default Enum
compartmentId Compartment OCID string No - -
description Target responder description string No - -
displayName Target responder recipe display name string No - -
effectiveResponderRules List of currently enabled responder rules for the responder type for recipe after applying defaults list[object] No - -
id Unique identifier of target responder recipe that can't be changed after creation string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the example string No - -
locks Locks associated with this resource. list[object] No - -
owner Owner of target responder recipe string No - -
responderRecipeId Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned string No - -
responderRules List of responder rules associated with the recipe - user input list[object] No - -
status - object Yes - -
timeCreated The date and time the target responder recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target responder recipe rule was last updated. Format defined by RFC3339. string No - -

Status.effectiveResponderRules[]

Back to TargetResponderRecipe status

TargetResponderRecipeEffectiveResponderRuleFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.

Field Description Type Required Default Enum
compartmentId Compartment OCID string No - -
description Responder rule description string No - -
details TargetResponderRecipeEffectiveResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.Details. object No - -
displayName Responder rule display name string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
lifecycleState The current lifecycle state of the responder rule string No - -
policies List of policies list[string] No - -
responderRuleId Unique identifier for the responder rule string No - -
supportedModes Supported execution modes for the responder rule list[string] No - -
timeCreated The date and time the target responder recipe rule was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the target responder recipe rule was last updated. Format defined by RFC3339. string No - -
type Type of responder string No - -

Status.effectiveResponderRules[].details

Back to TargetResponderRecipe status

TargetResponderRecipeEffectiveResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.Details.

Field Description Type Required Default Enum
condition TargetResponderRecipeEffectiveResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
isEnabled Enabled state for the responder rule boolean No - -
mode Execution mode for the responder rule string No - -

Status.effectiveResponderRules[].details.condition

Back to TargetResponderRecipe status

TargetResponderRecipeEffectiveResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.effectiveResponderRules[].details.configurations[]

Back to TargetResponderRecipe status

TargetResponderRecipeEffectiveResponderRuleDetailsConfigurationFields defines nested fields for TargetResponderRecipe.EffectiveResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string No - -
name Configuration name string No - -
value Configuration value string No - -

Status.locks[]

Back to TargetResponderRecipe status

TargetResponderRecipeLockFields defines nested fields for TargetResponderRecipe.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.responderRules[]

Back to TargetResponderRecipe status

TargetResponderRecipeResponderRuleFields defines nested fields for TargetResponderRecipe.ResponderRule.

Field Description Type Required Default Enum
details TargetResponderRecipeResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.ResponderRule.Details. object Yes - -
responderRuleId Unique identifier for target detector recipe string Yes - -

Status.responderRules[].details

Back to TargetResponderRecipe status

TargetResponderRecipeResponderRuleDetailsFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.

Field Description Type Required Default Enum
condition TargetResponderRecipeResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Condition. object No - -
configurations List of responder rule configurations list[object] No - -
mode Execution mode for the responder rule string No - -

Status.responderRules[].details.condition

Back to TargetResponderRecipe status

TargetResponderRecipeResponderRuleDetailsConditionFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Condition.

Field Description Type Required Default Enum
compositeOperator Composite condition operator string No - -
jsonData - string No - -
kind - string No - -
leftOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
operator Type of operator string No - -
parameter Parameter key string No - -
rightOperand JSONValue preserves arbitrary JSON values inside generated CRD fields. Unknown nested fields are preserved. object (preserves unknown fields) No - -
value Value of operator in condition string No - -
valueType Type of value in condition string No - -

Status.responderRules[].details.configurations[]

Back to TargetResponderRecipe status

TargetResponderRecipeResponderRuleDetailsConfigurationFields defines nested fields for TargetResponderRecipe.ResponderRule.Details.Configuration.

Field Description Type Required Default Enum
configKey Unique identifier of the configuration string Yes - -
name Configuration name string Yes - -
value Configuration value string Yes - -

Status.status

Back to TargetResponderRecipe status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to TargetResponderRecipe status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to TargetResponderRecipe status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to TargetResponderRecipe status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

WlpAgent

WlpAgent is the Schema for the wlpagents API.

  • Plural: wlpagents
  • Scope: Namespaced
  • APIVersion: cloudguard.oracle.com/v1beta1
  • Sample: Sample (config/samples/cloudguard_v1beta1_wlpagent.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

WlpAgentSpec defines the desired state of WlpAgent.

Field Description Type Required Default Enum
agentVersion The version of the agent making the request string Yes - -
certificateSignedRequest The certificate signed request containing domain, organization names, organization units, city, state, country, email and public key, among other certificate details, signed by private key string Yes - -
compartmentId Compartment OCID of the host string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
freeformTags 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. map[string, string] No - -
osInfo Concatenated OS name, OS version and agent architecture; for example, ubuntu_22.0_amd64. string Yes - -

Status

WlpAgentStatus defines the observed state of WlpAgent.

Field Description Type Required Default Enum
agentVersion The version of the agent string No - -
certificateId The certificate ID returned by OCI certificates service string No - -
certificateSignedRequest The updated certificate signing request string No - -
compartmentId Compartment OCID of WlpAgent. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
freeformTags 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. map[string, string] No - -
hostId OCID for instance in which WlpAgent is installed string No - -
id OCID for WlpAgent string No - -
locks Locks associated with this resource. list[object] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
tenantId TenantId of the host string No - -
timeCreated The date and time the WlpAgent was created. Format defined by RFC3339. string No - -
timeUpdated The date and time the WlpAgent was updated. Format defined by RFC3339. string No - -

Status.locks[]

Back to WlpAgent status

WlpAgentLock defines nested fields for WlpAgent.Lock.

Field Description Type Required Default Enum
message A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. string No - -
relatedResourceId The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. string No - -
timeCreated When the lock was created, in the format defined by RFC 3339. string No - -
type Type of the lock. string No - -

Status.status

Back to WlpAgent status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to WlpAgent status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to WlpAgent status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to WlpAgent status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -