Skip to main content
← back to extensions

@swamp/gcp/backupdr

v2026.04.23.1

Google Cloud backupdr infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudbackupdrcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/backupdr

@swamp/gcp/backupdr/backupplanassociationsv2026.04.23.1backupplanassociations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
alloydbClusterBackupPlanAssociationProperties?objectProperties for an AlloyDB cluster backup plan association.
backupPlan?stringRequired. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
cloudSqlInstanceBackupPlanAssociationProperties?objectCloud SQL instance's BPA properties.
filestoreInstanceBackupPlanAssociationProperties?objectFilestore instance's BPA properties.
resource?stringRequired. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
resourceType?stringRequired. Immutable. Resource type of workload on which backupplan is applied
backupPlanAssociationId?stringRequired. The name of the backup plan association to create. The name must be unique for the specified project and location.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backupPlanAssociations
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backupPlanAssociations
ArgumentTypeDescription
identifierstringThe name of the backupPlanAssociations
updateUpdate backupPlanAssociations attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backupPlanAssociations
ArgumentTypeDescription
identifierstringThe name of the backupPlanAssociations
syncSync backupPlanAssociations state from GCP
fetch_for_resource_typefetch for resource type
trigger_backuptrigger backup
ArgumentTypeDescription
customRetentionDays?any
labels?any
requestId?any
ruleId?any

Resources

state(infinite)— A BackupPlanAssociation represents a single BackupPlanAssociation which conta...
@swamp/gcp/backupdr/backupplansv2026.04.23.1backupplans.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
backupRules?arrayOptional. The backup rules for this `BackupPlan`.
backupVault?stringRequired. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
computeInstanceBackupPlanProperties?object--- ComputeInstanceBackupPlanProperties Message ---
description?stringOptional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
diskBackupPlanProperties?object--- DiskBackupPlanProperties Message ---
labels?recordOptional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
logRetentionDays?stringOptional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
maxCustomOnDemandRetentionDays?numberOptional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
resourceType?stringRequired. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
backupPlanId?stringRequired. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backupPlans
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backupPlans
ArgumentTypeDescription
identifierstringThe name of the backupPlans
updateUpdate backupPlans attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backupPlans
ArgumentTypeDescription
identifierstringThe name of the backupPlans
syncSync backupPlans state from GCP

Resources

state(infinite)— A `BackupPlan` specifies some common fields, such as `description` as well as...
@swamp/gcp/backupdr/backupplans-revisionsv2026.04.23.1backupplans_revisions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a revisions
ArgumentTypeDescription
identifierstringThe name of the revisions
syncSync revisions state from GCP

Resources

state(infinite)— `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
@swamp/gcp/backupdr/backupvaultsv2026.04.23.1backupvaults.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessRestriction?enumOptional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
annotations?recordOptional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
backupMinimumEnforcedRetentionDuration?stringRequired. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
backupRetentionInheritance?enumOptional. Setting for how a backup's enforced retention end time is inherited.
description?stringOptional. The description of the BackupVault instance (2048 characters or less).
effectiveTime?stringOptional. Time after which the BackupVault resource is locked.
encryptionConfig?objectMessage describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest.
labels?recordOptional. Resource labels to represent user provided metadata. No labels currently defined:
backupVaultId?stringRequired. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backupVaults
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backupVaults
ArgumentTypeDescription
identifierstringThe name of the backupVaults
updateUpdate backupVaults attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backupVaults
ArgumentTypeDescription
identifierstringThe name of the backupVaults
syncSync backupVaults state from GCP
fetch_usablefetch usable

Resources

state(infinite)— Message describing a BackupVault object.
@swamp/gcp/backupdr/backupvaults-datasourcesv2026.04.23.1backupvaults_datasources.ts

Global Arguments

ArgumentTypeDescription
backupBlockedByVaultAccessRestriction?booleanOutput only. This field is set to true if the backup is blocked by vault access restriction.
backupConfigInfo?objectBackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.
backupCount?stringNumber of backups in the data source.
configState?enumOutput only. The backup configuration state.
createTime?stringOutput only. The time when the instance was created.
dataSourceBackupApplianceApplication?objectBackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.
dataSourceGcpResource?objectDataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource
etag?stringServer specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
labels?recordOptional. Resource labels to represent user provided metadata. No labels currently defined:
name?stringOutput only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
state?enumOutput only. The DataSource resource instance state.
totalStoredBytes?stringThe number of bytes (metadata and data) stored in this datasource.
updateTime?stringOutput only. The time when the instance was updated.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a dataSources
ArgumentTypeDescription
identifierstringThe name of the dataSources
updateUpdate dataSources attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the dataSources
ArgumentTypeDescription
identifierstringThe name of the dataSources
syncSync dataSources state from GCP
abandon_backupabandon backup
ArgumentTypeDescription
requestId?any
fetch_access_tokenfetch access token
ArgumentTypeDescription
generationId?any
finalize_backupfinalize backup
ArgumentTypeDescription
backupId?any
consistencyTime?any
description?any
recoveryRangeEndTime?any
recoveryRangeStartTime?any
requestId?any
retentionDuration?any
initiate_backupinitiate backup
ArgumentTypeDescription
backupId?any
requestId?any
set_internal_statusset internal status
ArgumentTypeDescription
backupConfigState?any
requestId?any
value?any

Resources

state(infinite)— Message describing a DataSource object. Datasource object used to represent D...
@swamp/gcp/backupdr/backupvaults-datasources-backupsv2026.04.23.1backupvaults_datasources_backups.ts

Global Arguments

ArgumentTypeDescription
alloyDbBackupProperties?objectAlloyDbClusterBackupProperties represents AlloyDB cluster backup properties..
backupApplianceBackupProperties?objectBackupApplianceBackupProperties represents BackupDR backup appliance's properties.
backupApplianceLocks?arrayOptional. The list of BackupLocks taken by the accessor Backup Appliance.
backupRetentionInheritance?enumOutput only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
backupType?enumOutput only. Type of the backup, unspecified, scheduled or ondemand.
cloudSqlInstanceBackupProperties?objectCloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties.
computeInstanceBackupProperties?objectComputeInstanceBackupProperties represents Compute Engine instance backup properties.
consistencyTime?stringOutput only. The point in time when this backup was captured from the source.
createTime?stringOutput only. The time when the instance was created.
description?stringOutput only. The description of the Backup instance (2048 characters or less).
diskBackupProperties?objectDiskBackupProperties represents the properties of a Disk backup.
enforcedRetentionEndTime?stringOptional. The backup can not be deleted before this time.
etag?stringOptional. Server specified ETag to prevent updates from overwriting each other.
expireTime?stringOptional. When this backup is automatically expired.
filestoreInstanceBackupProperties?objectFilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource..
gcpBackupPlanInfo?objectGCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.
gcpResource?objectMinimum details to identify a Google Cloud resource for a backup.
kmsKeyVersions?arrayOptional. Output only. The list of KMS key versions used to encrypt the backup.
labels?recordOptional. Resource labels to represent user provided metadata. No labels currently defined.
name?stringOutput only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
resourceSizeBytes?stringOutput only. source resource size in bytes at the time of the backup.
satisfiesPzi?booleanOptional. Output only. Reserved for future use.
satisfiesPzs?booleanOptional. Output only. Reserved for future use.
serviceLocks?arrayOutput only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
state?enumOutput only. The Backup resource instance state.
updateTime?stringOutput only. The time when the instance was updated.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a backups
ArgumentTypeDescription
identifierstringThe name of the backups
updateUpdate backups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP
fetch_for_resource_typefetch for resource type
restorerestore
ArgumentTypeDescription
clearOverridesFieldMask?any
computeInstanceRestoreProperties?any
computeInstanceTargetEnvironment?any
diskRestoreProperties?any
diskTargetEnvironment?any
regionDiskTargetEnvironment?any
requestId?any

Resources

state(infinite)— Message describing a Backup object.
@swamp/gcp/backupdr/datasourcereferencesv2026.04.23.1datasourcereferences.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a dataSourceReferences
ArgumentTypeDescription
identifierstringThe name of the dataSourceReferences
syncSync dataSourceReferences state from GCP
fetch_for_resource_typefetch for resource type

Resources

state(infinite)— DataSourceReference is a reference to a DataSource resource.
@swamp/gcp/backupdr/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP
get_trialget trial

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/backupdr/managementserversv2026.04.23.1managementservers.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
description?stringOptional. The description of the ManagementServer instance (2048 characters or less).
labels?recordOptional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
managementUri?objectManagementURI for the Management Server resource.
networks?arrayOptional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
type?enumOptional. The type of the ManagementServer resource.
workforceIdentityBasedManagementUri?objectManagementURI depending on the Workforce Identity i.e. either 1p or 3p.
workforceIdentityBasedOauth2ClientId?objectOAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,
managementServerId?stringRequired. The name of the management server to create. The name must be unique for the specified project and location.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a managementServers
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a managementServers
ArgumentTypeDescription
identifierstringThe name of the managementServers
deleteDelete the managementServers
ArgumentTypeDescription
identifierstringThe name of the managementServers
syncSync managementServers state from GCP
ms_compliance_metadatams compliance metadata
ArgumentTypeDescription
projectId?any

Resources

state(infinite)— ManagementServer describes a single BackupDR ManagementServer instance.
@swamp/gcp/backupdr/resourcebackupconfigsv2026.04.23.1resourcebackupconfigs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a resourceBackupConfigs
ArgumentTypeDescription
identifierstringThe name of the resourceBackupConfigs
syncSync resourceBackupConfigs state from GCP

Resources

state(infinite)— ResourceBackupConfig represents a resource along with its backup configurations.