backup_vaults

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

Overview

Name	backup_vaults
Type	Resource
Id	google.netapp.backup_vaults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.
backupRegion	string	Optional. Region where the backups are stored. Format: projects/{project_id}/locations/{location}
backupRetentionPolicy	object	Optional. Backup retention policy defining the retention of backups. (id: BackupRetentionPolicy)
backupVaultType	string	Optional. Type of backup vault to be created. Default is IN_REGION. (BACKUP_VAULT_TYPE_UNSPECIFIED, IN_REGION, CROSS_REGION)
backupsCryptoKeyVersion	string	Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
createTime	string (google-datetime)	Output only. Create time of the backup vault.
description	string	Description of the backup vault.
destinationBackupVault	string	Output only. Name of the Backup vault created in backup region. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
encryptionState	string	Output only. Field indicating encryption state of CMEK backups. (ENCRYPTION_STATE_UNSPECIFIED, ENCRYPTION_STATE_PENDING, ENCRYPTION_STATE_COMPLETED, ENCRYPTION_STATE_IN_PROGRESS, ENCRYPTION_STATE_FAILED)
kmsConfig	string	Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config}
labels	object	Resource labels to represent user provided metadata.
sourceBackupVault	string	Output only. Name of the Backup vault created in source region. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
sourceRegion	string	Optional. Region in which the backup vault is created. Format: projects/{project_id}/locations/{location}
state	string	Output only. The backup vault state. (STATE_UNSPECIFIED, CREATING, READY, DELETING, ERROR, UPDATING)

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backupVaultsId		Returns the description of the specified backup vault
list	select	projectsId, locationsId	pageSize, orderBy, filter, pageToken	Returns list of all available backup vaults.
create	insert	projectsId, locationsId	backupVaultId	Creates new backup vault
patch	update	projectsId, locationsId, backupVaultsId	updateMask	Updates the settings of a specific backup vault.
delete	delete	projectsId, locationsId, backupVaultsId		Warning! This operation will permanently delete the backup vault.

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
backupVaultsId	string
locationsId	string
projectsId	string
backupVaultId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the description of the specified backup vault

SELECT
name,
backupRegion,
backupRetentionPolicy,
backupVaultType,
backupsCryptoKeyVersion,
createTime,
description,
destinationBackupVault,
encryptionState,
kmsConfig,
labels,
sourceBackupVault,
sourceRegion,
state
FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupVaultsId = '{{ backupVaultsId }}' -- required
;

list

Returns list of all available backup vaults.

SELECT
*
FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates new backup vault

INSERT INTO google.netapp.backup_vaults (
data__sourceRegion,
data__labels,
data__backupRegion,
data__description,
data__name,
data__kmsConfig,
data__backupRetentionPolicy,
data__backupVaultType,
projectsId,
locationsId,
backupVaultId
)
SELECT 
'{{ sourceRegion }}',
'{{ labels }}',
'{{ backupRegion }}',
'{{ description }}',
'{{ name }}',
'{{ kmsConfig }}',
'{{ backupRetentionPolicy }}',
'{{ backupVaultType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ backupVaultId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: backup_vaults
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the backup_vaults resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the backup_vaults resource.
  - name: sourceRegion
    value: "{{ sourceRegion }}"
    description: |
      Optional. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`
  - name: labels
    value: "{{ labels }}"
    description: |
      Resource labels to represent user provided metadata.
  - name: backupRegion
    value: "{{ backupRegion }}"
    description: |
      Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`
  - name: description
    value: "{{ description }}"
    description: |
      Description of the backup vault.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
  - name: kmsConfig
    value: "{{ kmsConfig }}"
    description: |
      Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`
  - name: backupRetentionPolicy
    description: |
      Optional. Backup retention policy defining the retention of backups.
    value:
      backupMinimumEnforcedRetentionDays: {{ backupMinimumEnforcedRetentionDays }}
      manualBackupImmutable: {{ manualBackupImmutable }}
      dailyBackupImmutable: {{ dailyBackupImmutable }}
      weeklyBackupImmutable: {{ weeklyBackupImmutable }}
      monthlyBackupImmutable: {{ monthlyBackupImmutable }}
  - name: backupVaultType
    value: "{{ backupVaultType }}"
    description: |
      Optional. Type of backup vault to be created. Default is IN_REGION.
    valid_values: ['BACKUP_VAULT_TYPE_UNSPECIFIED', 'IN_REGION', 'CROSS_REGION']
  - name: backupVaultId
    value: "{{ backupVaultId }}"

UPDATE examples

patch

Updates the settings of a specific backup vault.

UPDATE google.netapp.backup_vaults
SET 
data__sourceRegion = '{{ sourceRegion }}',
data__labels = '{{ labels }}',
data__backupRegion = '{{ backupRegion }}',
data__description = '{{ description }}',
data__name = '{{ name }}',
data__kmsConfig = '{{ kmsConfig }}',
data__backupRetentionPolicy = '{{ backupRetentionPolicy }}',
data__backupVaultType = '{{ backupVaultType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupVaultsId = '{{ backupVaultsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Warning! This operation will permanently delete the backup vault.

DELETE FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupVaultsId = '{{ backupVaultsId }}' --required
;