resource_backup_configs

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

Overview

Name	resource_backup_configs
Type	Resource
Id	google.backupdr.resource_backup_configs

Fields

The following fields are returned by SELECT queries:

fetch

Name	Datatype	Description
nextPageToken	string	A token identifying a page of results the server should return.
resourceBackupConfigs	array	The list of ResourceBackupConfigs for the specified scope.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
backupConfigsDetails	array	Backup 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.
backupConfigured	boolean	Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
targetResource	string	Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
targetResourceDisplayName	string	Output only. The human friendly name of the target resource.
targetResourceLabels	object	Labels associated with the target resource.
targetResourceType	string	Output only. The type of the target resource. (RESOURCE_TYPE_UNSPECIFIED, CLOUD_SQL_INSTANCE, COMPUTE_ENGINE_VM, COMPUTE_ENGINE_DISK, COMPUTE_ENGINE_REGIONAL_DISK, FILESTORE_INSTANCE)
uid	string	Output only. The unique identifier of the resource backup config.
vaulted	boolean	Output 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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
fetch	select	foldersId, locationsId	pageToken, filter, pageSize, orderBy	Fetches ResourceBackupConfigs.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists 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.

Name	Datatype	Description
foldersId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

fetch

Fetches ResourceBackupConfigs.

SELECT
nextPageToken,
resourceBackupConfigs
FROM google.backupdr.resource_backup_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

list

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 }}'
;