Skip to main content

resource_backup_configs

Creates, updates, deletes, gets or lists a resource_backup_configs resource.

Overview

Nameresource_backup_configs
TypeResource
Idgoogle.backupdr.resource_backup_configs

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
backupConfigsDetailsarrayBackup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
backupConfiguredbooleanOutput only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
targetResourcestringOutput only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
targetResourceDisplayNamestringOutput only. The human friendly name of the target resource.
targetResourceLabelsobjectLabels associated with the target resource.
targetResourceTypestringOutput only. The type of the target resource.
uidstringOutput only. The unique identifier of the resource backup config.
vaultedbooleanOutput only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists ResourceBackupConfigs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Lists ResourceBackupConfigs.

SELECT
name,
backupConfigsDetails,
backupConfigured,
targetResource,
targetResourceDisplayName,
targetResourceLabels,
targetResourceType,
uid,
vaulted
FROM google.backupdr.resource_backup_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';