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

# gcp_gkebackup_backup{% #gcp_gkebackup_backup %}

## `all_namespaces`{% #all_namespaces %}

**Type**: `BOOLEAN`**Provider name**: `allNamespaces`**Description**: Output only. If True, all namespaces were included in the Backup.

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `cluster_metadata`{% #cluster_metadata %}

**Type**: `STRUCT`**Provider name**: `clusterMetadata`**Description**: Output only. Information about the GKE cluster from which this Backup was created.

- `anthos_version`**Type**: `STRING`**Provider name**: `anthosVersion`**Description**: Output only. Anthos version
- `cluster`**Type**: `STRING`**Provider name**: `cluster`**Description**: Output only. The source cluster from which this Backup was created. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` This is inherited from the parent BackupPlan's cluster field.
- `gke_version`**Type**: `STRING`**Provider name**: `gkeVersion`**Description**: Output only. GKE version
- `k8s_version`**Type**: `STRING`**Provider name**: `k8sVersion`**Description**: Output only. The Kubernetes server version of the source cluster.

## `complete_time`{% #complete_time %}

**Type**: `TIMESTAMP`**Provider name**: `completeTime`**Description**: Output only. Completion time of the Backup

## `config_backup_size_bytes`{% #config_backup_size_bytes %}

**Type**: `INT64`**Provider name**: `configBackupSizeBytes`**Description**: Output only. The size of the config backup in bytes.

## `contains_secrets`{% #contains_secrets %}

**Type**: `BOOLEAN`**Provider name**: `containsSecrets`**Description**: Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

## `contains_volume_data`{% #contains_volume_data %}

**Type**: `BOOLEAN`**Provider name**: `containsVolumeData`**Description**: Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

## `create_time`{% #create_time %}

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

## `delete_lock_days`{% #delete_lock_days %}

**Type**: `INT32`**Provider name**: `deleteLockDays`**Description**: Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update).

## `delete_lock_expire_time`{% #delete_lock_expire_time %}

**Type**: `TIMESTAMP`**Provider name**: `deleteLockExpireTime`**Description**: Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).

## `description`{% #description %}

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

## `encryption_key`{% #encryption_key %}

**Type**: `STRUCT`**Provider name**: `encryptionKey`**Description**: Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value.

- `gcp_kms_encryption_key`**Type**: `STRING`**Provider name**: `gcpKmsEncryptionKey`**Description**: Optional. Google Cloud KMS encryption key. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`

## `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 backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `manual`{% #manual %}

**Type**: `BOOLEAN`**Provider name**: `manual`**Description**: Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*`

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `permissive_mode`{% #permissive_mode %}

**Type**: `BOOLEAN`**Provider name**: `permissiveMode`**Description**: Output only. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.

## `pod_count`{% #pod_count %}

**Type**: `INT32`**Provider name**: `podCount`**Description**: Output only. The total number of Kubernetes Pods contained in the Backup.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_count`{% #resource_count %}

**Type**: `INT32`**Provider name**: `resourceCount`**Description**: Output only. The total number of Kubernetes resources included in the Backup.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `retain_days`{% #retain_days %}

**Type**: `INT32`**Provider name**: `retainDays`**Description**: Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.

## `retain_expire_time`{% #retain_expire_time %}

**Type**: `TIMESTAMP`**Provider name**: `retainExpireTime`**Description**: Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).

## `satisfies_pzi`{% #satisfies_pzi %}

**Type**: `BOOLEAN`**Provider name**: `satisfiesPzi`**Description**: Output only. [Output Only] Reserved for future use.

## `satisfies_pzs`{% #satisfies_pzs %}

**Type**: `BOOLEAN`**Provider name**: `satisfiesPzs`**Description**: Output only. [Output Only] Reserved for future use.

## `selected_applications`{% #selected_applications %}

**Type**: `STRUCT`**Provider name**: `selectedApplications`**Description**: Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.

- `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`{% #selected_namespaces %}

**Type**: `STRUCT`**Provider name**: `selectedNamespaces`**Description**: Output only. If set, the list of namespaces that were included in the Backup.

- `namespaces`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `namespaces`**Description**: Optional. A list of Kubernetes Namespaces.

## `size_bytes`{% #size_bytes %}

**Type**: `INT64`**Provider name**: `sizeBytes`**Description**: Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. Current state of the Backup**Possible values**:

- `STATE_UNSPECIFIED` - The Backup resource is in the process of being created.
- `CREATING` - The Backup resource has been created and the associated BackupJob Kubernetes resource has been injected into the source cluster.
- `IN_PROGRESS` - The gkebackup agent in the cluster has begun executing the backup operation.
- `SUCCEEDED` - The backup operation has completed successfully.
- `FAILED` - The backup operation has failed.
- `DELETING` - This Backup resource (and its associated artifacts) is in the process of being deleted.

## `state_reason`{% #state_reason %}

**Type**: `STRING`**Provider name**: `stateReason`**Description**: Output only. Human-readable description of why the backup 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 [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)

## `update_time`{% #update_time %}

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

## `volume_count`{% #volume_count %}

**Type**: `INT32`**Provider name**: `volumeCount`**Description**: Output only. The total number of volume backups contained in the Backup.

## `zone_id`{% #zone_id %}

**Type**: `STRING`