Stay organized with collections
Save and categorize content based on your preferences.
Annotations
This page outlines the annotations supported by Config Connector resources.
Generic annotations
Generic annotations can be applied to all Config Connector resources. You can
find the list of generic annotations and their descriptions in the following
table.
Annotation
Description
cnrm.cloud.google.com/deletion-policy: POLICY
Can be "none" or "abandon". When deleting a Config Connector resource the
associated Google Cloud resource is deleted by default. To keep the
Google Cloud resource, specify "abandon". Default value is "none".
Can be "true" or "false". Indicates resources which should be skipped
when running outside a server environment. For example, these resources will
not be exported as Terraform.
Default value is "false".
cnrm.cloud.google.com/reconcile-interval-in-seconds: NUMBER
Resource-specific annotations configure Config Connector to take additional
actions beyond creating or deleting resources.
For example, Cloud Storage doesn't let you delete a StorageBucket that
contains objects. Applying the force-destroy annotation to the bucket and then
deleting the bucket causes Config Connector to delete all of the objects within
the bucket first, then deletes the bucket.
For example, the force-destroy directive is declared in the following YAML
snippet.
This annotation is added and managed by Config Connector for resources
with mutable
but unreadable fields (for example, "password" field in some resource spec).
cnrm.cloud.google.com/observed-secret-versions
This annotation is added and managed by Config Connector for resources
with sensitive fields.
cnrm.cloud.google.com/supports-ssa
This annotation is added and managed by Config Connector for resources
with server-side apply enabled
.
cnrm.cloud.google.com/blueprint
This annotation is added for resources used in KRM blueprints.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eConfig Connector resources support generic annotations that apply across all resource types, as well as resource-specific annotations that trigger additional actions.\u003c/p\u003e\n"],["\u003cp\u003eGeneric annotations include \u003ccode\u003edeletion-policy\u003c/code\u003e to manage the deletion behavior of associated Google Cloud resources, \u003ccode\u003emanagement-conflict-prevention-policy\u003c/code\u003e for handling conflicts, \u003ccode\u003eignore-clusterless\u003c/code\u003e for environment-specific exclusions, and \u003ccode\u003ereconcile-interval-in-seconds\u003c/code\u003e for configuring reconciliation frequency.\u003c/p\u003e\n"],["\u003cp\u003eResource-specific annotations, such as \u003ccode\u003eforce-destroy\u003c/code\u003e for StorageBuckets, allow for custom actions, and users should refer to each resource's reference page for available annotations.\u003c/p\u003e\n"],["\u003cp\u003eInternal annotations, like \u003ccode\u003emutable-but-unreadable-fields\u003c/code\u003e, \u003ccode\u003eobserved-secret-versions\u003c/code\u003e, \u003ccode\u003esupports-ssa\u003c/code\u003e, and \u003ccode\u003eblueprint\u003c/code\u003e, are managed by Config Connector and should not be modified by users.\u003c/p\u003e\n"]]],[],null,["# Annotations\n===========\n\n*** ** * ** ***\n\nThis page outlines the annotations supported by Config Connector resources.\n\nGeneric annotations\n-------------------\n\nGeneric annotations can be applied to all Config Connector resources. You can\nfind the list of generic annotations and their descriptions in the following\ntable.\n\nResource-specific annotations\n-----------------------------\n\nResource-specific annotations configure Config Connector to take additional\nactions beyond creating or deleting resources.\n\nFor example, Cloud Storage doesn't let you delete a `StorageBucket` that\ncontains objects. Applying the `force-destroy` annotation to the bucket and then\ndeleting the bucket causes Config Connector to delete all of the objects within\nthe bucket first, then deletes the bucket.\n\nFor example, the `force-destroy` directive is declared in the following YAML\nsnippet. \n\n metadata:\n annotations:\n cnrm.cloud.google.com/force-destroy: \"true\"\n\nCheck each Config Connector resource's [reference page](/config-connector/docs/reference/resources) to learn\nresource-specific annotations.\n\nAnnotations for internal usage\n------------------------------\n\nThe following annotations are managed by Config Connector. You must never set or\nedit any of them."]]
