---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_gkebackup_restore_plan{% #gcp_gkebackup_restore_plan %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `backup_plan`{% #backup_plan %}

**Type**: `STRING`**Provider name**: `backupPlan`**Description**: Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`.

## `cluster`{% #cluster %}

**Type**: `STRING`**Provider name**: `cluster`**Description**: Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. The timestamp when this RestorePlan resource was created.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: Optional. User specified descriptive string for this RestorePlan.

## `etag`{% #etag %}

**Type**: `STRING`**Provider name**: `etag`**Description**: Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `restore_config`{% #restore_config %}

**Type**: `STRUCT`**Provider name**: `restoreConfig`**Description**: Required. Configuration of Restores created via this RestorePlan.

- `all_namespaces`**Type**: `BOOLEAN`**Provider name**: `allNamespaces`**Description**: Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
- `cluster_resource_conflict_policy`**Type**: `STRING`**Provider name**: `clusterResourceConflictPolicy`**Description**: Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.**Possible values**:
  - `CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED` - Unspecified. Only allowed if no cluster-scoped resources will be restored.
  - `USE_EXISTING_VERSION` - Do not attempt to restore the conflicting resource.
  - `USE_BACKUP_VERSION` - Delete the existing version before re-creating it from the Backup. This is a dangerous option which could cause unintentional data loss if used inappropriately. For example, deleting a CRD will cause Kubernetes to delete all CRs of that type.
- `cluster_resource_restore_scope`**Type**: `STRUCT`**Provider name**: `clusterResourceRestoreScope`**Description**: Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
  - `all_group_kinds`**Type**: `BOOLEAN`**Provider name**: `allGroupKinds`**Description**: Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
  - `excluded_group_kinds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `excludedGroupKinds`**Description**: Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
    - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
    - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
  - `no_group_kinds`**Type**: `BOOLEAN`**Provider name**: `noGroupKinds`**Description**: Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
  - `selected_group_kinds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `selectedGroupKinds`**Description**: Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
    - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
    - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
- `excluded_namespaces`**Type**: `STRUCT`**Provider name**: `excludedNamespaces`**Description**: A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
  - `namespaces`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `namespaces`**Description**: Optional. A list of Kubernetes Namespaces.
- `namespaced_resource_restore_mode`**Type**: `STRING`**Provider name**: `namespacedResourceRestoreMode`**Description**: Optional. Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.**Possible values**:
  - `NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED` - Unspecified (invalid).
  - `DELETE_AND_RESTORE` - When conflicting top-level resources (either Namespaces or ProtectedApplications, depending upon the scope) are encountered, this will first trigger a delete of the conflicting resource AND ALL OF ITS REFERENCED RESOURCES (e.g., all resources in the Namespace or all resources referenced by the ProtectedApplication) before restoring the resources from the Backup. This mode should only be used when you are intending to revert some portion of a cluster to an earlier state.
  - `FAIL_ON_CONFLICT` - If conflicting top-level resources (either Namespaces or ProtectedApplications, depending upon the scope) are encountered at the beginning of a restore process, the Restore will fail. If a conflict occurs during the restore process itself (e.g., because an out of band process creates conflicting resources), a conflict will be reported.
  - `MERGE_SKIP_ON_CONFLICT` - This mode merges the backup and the target cluster and skips the conflicting resources. If a single resource to restore exists in the cluster before restoration, the resource will be skipped, otherwise it will be restored.
  - `MERGE_REPLACE_VOLUME_ON_CONFLICT` - This mode merges the backup and the target cluster and skips the conflicting resources except volume data. If a PVC to restore already exists, this mode will restore/reconnect the volume without overwriting the PVC. It is similar to MERGE_SKIP_ON_CONFLICT except that it will apply the volume data policy for the conflicting PVCs: - RESTORE_VOLUME_DATA_FROM_BACKUP: restore data only and respect the reclaim policy of the original PV; - REUSE_VOLUME_HANDLE_FROM_BACKUP: reconnect and respect the reclaim policy of the original PV; - NO_VOLUME_DATA_RESTORATION: new provision and respect the reclaim policy of the original PV. Note that this mode could cause data loss as the original PV can be retained or deleted depending on its reclaim policy.
  - `MERGE_REPLACE_ON_CONFLICT` - This mode merges the backup and the target cluster and replaces the conflicting resources with the ones in the backup. If a single resource to restore exists in the cluster before restoration, the resource will be replaced with the one from the backup. To replace an existing resource, the first attempt is to update the resource to match the one from the backup; if the update fails, the second attempt is to delete the resource and restore it from the backup. Note that this mode could cause data loss as it replaces the existing resources in the target cluster, and the original PV can be retained or deleted depending on its reclaim policy.
- `no_namespaces`**Type**: `BOOLEAN`**Provider name**: `noNamespaces`**Description**: Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
- `restore_order`**Type**: `STRUCT`**Provider name**: `restoreOrder`**Description**: Optional. RestoreOrder contains custom ordering to use on a Restore.
  - `group_kind_dependencies`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `groupKindDependencies`**Description**: Optional. Contains a list of group kind dependency pairs provided by the customer, that is used by Backup for GKE to generate a group kind restore order.
    - `requiring`**Type**: `STRUCT`**Provider name**: `requiring`**Description**: Required. The requiring group kind requires that the other group kind be restored first.
      - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
      - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
    - `satisfying`**Type**: `STRUCT`**Provider name**: `satisfying`**Description**: Required. The satisfying group kind must be restored first in order to satisfy the dependency.
      - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
      - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
- `selected_applications`**Type**: `STRUCT`**Provider name**: `selectedApplications`**Description**: A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
  - `namespaced_names`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `namespacedNames`**Description**: Optional. A list of namespaced Kubernetes resources.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Optional. The name of the Kubernetes resource.
    - `namespace`**Type**: `STRING`**Provider name**: `namespace`**Description**: Optional. The Namespace of the Kubernetes resource.
- `selected_namespaces`**Type**: `STRUCT`**Provider name**: `selectedNamespaces`**Description**: A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
  - `namespaces`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `namespaces`**Description**: Optional. A list of Kubernetes Namespaces.
- `substitution_rules`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `substitutionRules`**Description**: Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
  - `new_value`**Type**: `STRING`**Provider name**: `newValue`**Description**: Optional. This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").
  - `original_value_pattern`**Type**: `STRING`**Provider name**: `originalValuePattern`**Description**: Optional. (Filtering parameter) This is a [regular expression] ([https://en.wikipedia.org/wiki/Regular_expression](https://en.wikipedia.org/wiki/Regular_expression)) that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.
  - `target_group_kinds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `targetGroupKinds`**Description**: Optional. (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).
    - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
    - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
  - `target_json_path`**Type**: `STRING`**Provider name**: `targetJsonPath`**Description**: Required. This is a [JSONPath] ([https://kubernetes.io/docs/reference/kubectl/jsonpath/](https://kubernetes.io/docs/reference/kubectl/jsonpath/)) expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).
  - `target_namespaces`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `targetNamespaces`**Description**: Optional. (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
- `transformation_rules`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `transformationRules`**Description**: Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
  - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Optional. The description is a user specified string description of the transformation rule.
  - `field_actions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `fieldActions`**Description**: Required. A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
    - `from_path`**Type**: `STRING`**Provider name**: `fromPath`**Description**: Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.
    - `op`**Type**: `STRING`**Provider name**: `op`**Description**: Required. op specifies the operation to perform.**Possible values**:
      - `OP_UNSPECIFIED` - Unspecified operation
      - `REMOVE` - The 'remove' operation removes the value at the target location.
      - `MOVE` - The 'move' operation removes the value at a specified location and adds it to the target location.
      - `COPY` - The 'copy' operation copies the value at a specified location to the target location.
      - `ADD` - The 'add' operation performs one of the following functions, depending upon what the target location references: 1. If the target location specifies an array index, a new value is inserted into the array at the specified index. 2. If the target location specifies an object member that does not already exist, a new member is added to the object. 3. If the target location specifies an object member that does exist, that member's value is replaced.
      - `TEST` - The 'test' operation tests that a value at the target location is equal to a specified value.
      - `REPLACE` - The 'replace' operation replaces the value at the target location with a new value. The operation object MUST contain a 'value' member whose content specifies the replacement value.
    - `path`**Type**: `STRING`**Provider name**: `path`**Description**: Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.
    - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Optional. A string that specifies the desired value in string format to use for transformation.
  - `resource_filter`**Type**: `STRUCT`**Provider name**: `resourceFilter`**Description**: Optional. This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
    - `group_kinds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `groupKinds`**Description**: Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
      - `resource_group`**Type**: `STRING`**Provider name**: `resourceGroup`**Description**: Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group.
      - `resource_kind`**Type**: `STRING`**Provider name**: `resourceKind`**Description**: Optional. Kind of a Kubernetes resource, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
    - `json_path`**Type**: `STRING`**Provider name**: `jsonPath`**Description**: Optional. This is a [JSONPath] ([https://github.com/json-path/JsonPath/blob/master/README.md](https://github.com/json-path/JsonPath/blob/master/README.md)) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
    - `namespaces`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `namespaces`**Description**: Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).
- `volume_data_restore_policy`**Type**: `STRING`**Provider name**: `volumeDataRestorePolicy`**Description**: Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).**Possible values**:
  - `VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED` - Unspecified (illegal).
  - `RESTORE_VOLUME_DATA_FROM_BACKUP` - For each PVC to be restored, create a new underlying volume and PV from the corresponding VolumeBackup contained within the Backup.
  - `REUSE_VOLUME_HANDLE_FROM_BACKUP` - For each PVC to be restored, attempt to reuse the original PV contained in the Backup (with its original underlying volume). This option is likely only usable when restoring a workload to its original cluster.
  - `NO_VOLUME_DATA_RESTORATION` - For each PVC to be restored, create PVC without any particular action to restore data. In this case, the normal Kubernetes provisioning logic would kick in, and this would likely result in either dynamically provisioning blank PVs or binding to statically provisioned PVs.
- `volume_data_restore_policy_bindings`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `volumeDataRestorePolicyBindings`**Description**: Optional. A table that binds volumes by their scope to a restore policy. Bindings must have a unique scope. Any volumes not scoped in the bindings are subject to the policy defined in volume_data_restore_policy.
  - `policy`**Type**: `STRING`**Provider name**: `policy`**Description**: Required. The VolumeDataRestorePolicy to apply when restoring volumes in scope.**Possible values**:
    - `VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED` - Unspecified (illegal).
    - `RESTORE_VOLUME_DATA_FROM_BACKUP` - For each PVC to be restored, create a new underlying volume and PV from the corresponding VolumeBackup contained within the Backup.
    - `REUSE_VOLUME_HANDLE_FROM_BACKUP` - For each PVC to be restored, attempt to reuse the original PV contained in the Backup (with its original underlying volume). This option is likely only usable when restoring a workload to its original cluster.
    - `NO_VOLUME_DATA_RESTORATION` - For each PVC to be restored, create PVC without any particular action to restore data. In this case, the normal Kubernetes provisioning logic would kick in, and this would likely result in either dynamically provisioning blank PVs or binding to statically provisioned PVs.
  - `volume_type`**Type**: `STRING`**Provider name**: `volumeType`**Description**: The volume type, as determined by the PVC's bound PV, to apply the policy to.**Possible values**:
    - `VOLUME_TYPE_UNSPECIFIED` - Default
    - `GCE_PERSISTENT_DISK` - Compute Engine Persistent Disk volume

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.**Possible values**:

- `STATE_UNSPECIFIED` - Default first value for Enums.
- `CLUSTER_PENDING` - Waiting for cluster state to be RUNNING.
- `READY` - The RestorePlan has successfully been created and is ready for Restores.
- `FAILED` - RestorePlan creation has failed.
- `DELETING` - The RestorePlan is in the process of being deleted.

## `state_reason`{% #state_reason %}

**Type**: `STRING`**Provider name**: `stateReason`**Description**: Output only. Human-readable description of why RestorePlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `uid`{% #uid %}

**Type**: `STRING`**Provider name**: `uid`**Description**: Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output only. The timestamp when this RestorePlan resource was last updated.

## `zone_id`{% #zone_id %}

**Type**: `STRING`