Gcp/backupdr

@swamp/gcp/backupdrv2026.10.23.1· AGPL-3.0-or-later· 3d agoBEHAVIORS

01README

Google Cloud backupdr infrastructure models

02Release Notes

Updated: locations, appliedautoprotectionpolicies, autoprotectionpolicies, autoprotectionpolicies_bindings, autoprotectionpolicies_bindings_matchingresources, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

03Behaviors14

appliedautoprotectionpolicies.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a appliedAutoProtectionPolicies

Argument	Type	Required	Description
identifier	string	yes	The name of the appliedAutoProtectionPolicies

fn sync(identifier?: string)

Sync appliedAutoProtectionPolicies state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific appliedAutoProtectionPolicies by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List appliedAutoProtectionPolicies resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters resources listed in the response.
orderBy?	string	no	Optional. An expression that sorts the results in the response.
pageSize?	number	no	Optional. The maximum number of applied policies to return in a single page. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default page size of 500 will be used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and A...

autoprotectionpolicies.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
backupPlanDetails?	array	no	Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
criteria?	object	no	Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\\p{Ll}\\p{Lo}{0,62}`.
description?	string	no	Optional. A description of the policy.
name?	string	no	Identifier. The resource name of the AutoProtectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
autoProtectionPolicyId?	string	no	Required. The ID to use for the policy. This will become the final component of the policy's resource name.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a autoProtectionPolicies

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a autoProtectionPolicies

Argument	Type	Required	Description
identifier	string	yes	The name of the autoProtectionPolicies

fn update(identifier?: string, waitForReady?: boolean)

Update autoProtectionPolicies attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific autoProtectionPolicies by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the autoProtectionPolicies

Argument	Type	Required	Description
identifier	string	yes	The name of the autoProtectionPolicies

fn sync(identifier?: string)

Sync autoProtectionPolicies state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific autoProtectionPolicies by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List autoProtectionPolicies resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
orderBy?	string	no	Optional. An expression that sorts the results in the response. The following fields are sortable:
pageSize?	number	no	Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— An AutoprotectionPolicy is a policy resource designed to automate backup mana...

autoprotectionpolicies_bindings.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
description?	string	no	Optional. A description of the binding.
name?	string	no	Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`
scope?	string	no	Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id}
autoProtectionPolicyBindingId?	string	no	Required. The ID to use for the binding. This will become the final component of the binding's resource name.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a bindings

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a bindings

Argument	Type	Required	Description
identifier	string	yes	The name of the bindings

fn sync(identifier?: string)

Sync bindings state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific bindings by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List bindings resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
orderBy?	string	no	Optional. An expression that sorts the results in the response. The following fields are sortable:
pageSize?	number	no	Optional. The maximum number of policies to return in a single page is 500. If unspecified, a server-default value will be used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn initiate_delete()

initiate delete

Resources

state(infinite)— An AutoProtectionPolicyBinding (APPA) acts as the bridge between an AutoProte...

autoprotectionpolicies_bindings_matchingresources.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a matchingResources

Argument	Type	Required	Description
identifier	string	yes	The name of the matchingResources

fn sync(identifier?: string)

Sync matchingResources state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific matchingResources by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List matchingResources resources

Argument	Type	Required	Description
filter?	string	no	Optional. Field match expression used to filter the results.
orderBy?	string	no	Optional. Field by which to sort the results.
pageSize?	number	no	Optional. The maximum number of `BindingMatchingResources` to return in a single response. The default page size is 100 and maximum page size is 200. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— BindingMatchingResource contains the details of a resource that matches the c...

backupplanassociations.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
backupPlan?	string	no	Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
resource?	string	no	Required. 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?	string	no	Required. Immutable. Resource type of workload on which backupplan is applied
backupPlanAssociationId?	string	no	Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
requestId?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a backupPlanAssociations

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a backupPlanAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the backupPlanAssociations

fn update(identifier?: string, waitForReady?: boolean)

Update backupPlanAssociations attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupPlanAssociations by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the backupPlanAssociations

Argument	Type	Required	Description
identifier	string	yes	The name of the backupPlanAssociations

fn sync(identifier?: string)

Sync backupPlanAssociations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupPlanAssociations by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List backupPlanAssociations resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_for_resource_type(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any, resourceType?: any)

fetch for resource type

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no
resourceType?	any	no

fn trigger_backup(customRetentionDays?: any, labels?: any, requestId?: any, ruleId?: any)

trigger backup

Argument	Type	Required
customRetentionDays?	any	no
labels?	any	no
requestId?	any	no
ruleId?	any	no

Resources

state(infinite)— A BackupPlanAssociation represents a single BackupPlanAssociation which conta...

backupplans.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
backupRules?	array	no	Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
backupVault?	string	no	Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
computeInstanceBackupPlanProperties?	object	no	Optional. If true, only the boot disk will be backed up.
description?	string	no	Optional. 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	no	Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
labels?	record	no	Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
logRetentionDays?	string	no	Optional. 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?	number	no	Optional. 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?	string	no	Required. 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?	string	no	Required. 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?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a backupPlans

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a backupPlans

Argument	Type	Required	Description
identifier	string	yes	The name of the backupPlans

fn update(identifier?: string, waitForReady?: boolean)

Update backupPlans attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupPlans by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the backupPlans

Argument	Type	Required	Description
identifier	string	yes	The name of the backupPlans

fn sync(identifier?: string)

Sync backupPlans state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupPlans by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List backupPlans resources

Argument	Type	Required	Description
filter?	string	no	Optional. Field match expression used to filter the results.
orderBy?	string	no	Optional. Field by which to sort the results.
pageSize?	number	no	Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A `BackupPlan` specifies some common fields, such as `description` as well as...

backupplans_revisions.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a revisions

Argument	Type	Required	Description
identifier	string	yes	The name of the revisions

fn sync(identifier?: string)

Sync revisions state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific revisions by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List revisions resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.

backupvaults.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
accessRestriction?	enum	no	Optional. Restricts access to certain sources and destinations for data being sent into, or restored from, the backup vault. Defaults to WITHIN_ORGANIZATION if not provided during creation.
annotations?	record	no	Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
backupMinimumEnforcedRetentionDuration?	string	no	Required. 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?	enum	no	Optional. Setting for how a backup's enforced retention end time is inherited.
description?	string	no	Optional. The description of the BackupVault instance (2048 characters or less).
effectiveTime?	string	no	Optional. Time after which the BackupVault resource is locked.
encryptionConfig?	object	no	Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
labels?	record	no	Optional. Resource labels to represent user provided metadata. No labels currently defined:
backupVaultId?	string	no	Required. 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?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force?	string	no	Optional. If set to true, will not check plan duration against backup vault enforcement duration.
forceUpdateAccessRestriction?	string	no	Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a backupVaults

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a backupVaults

Argument	Type	Required	Description
identifier	string	yes	The name of the backupVaults

fn update(identifier?: string, waitForReady?: boolean)

Update backupVaults attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupVaults by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the backupVaults

Argument	Type	Required	Description
identifier	string	yes	The name of the backupVaults

fn sync(identifier?: string)

Sync backupVaults state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific backupVaults by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List backupVaults resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
view?	string	no	Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_usable(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)

fetch usable

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— Message describing a BackupVault object.

backupvaults_datasources.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
backupBlockedByVaultAccessRestriction?	boolean	no	Output only. This field is set to true if the backup is blocked by vault access restriction.
backupConfigInfo?	object	no	The name of the application.
backupCount?	string	no	Number of backups in the data source.
configState?	enum	no	Output only. The backup configuration state.
createTime?	string	no	Output only. The time when the instance was created.
dataSourceBackupApplianceApplication?	object	no	Appliance Id of the Backup Appliance.
dataSourceGcpResource?	object	no	Output only. The cluster UID of the AlloyDB cluster backed up by the datasource.
etag?	string	no	Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
labels?	record	no	Optional. Resource labels to represent user provided metadata. No labels currently defined:
name?	string	no	Output 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?	enum	no	Output only. The DataSource resource instance state.
totalStoredBytes?	string	no	The number of bytes (metadata and data) stored in this datasource.
updateTime?	string	no	Output only. The time when the instance was updated.
allowMissing?	string	no	Optional. Enable upsert.
requestId?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a dataSources

Argument	Type	Required	Description
identifier	string	yes	The name of the dataSources

fn update(identifier?: string, waitForReady?: boolean)

Update dataSources attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific dataSources by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the dataSources

Argument	Type	Required	Description
identifier	string	yes	The name of the dataSources

fn sync(identifier?: string)

Sync dataSources state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dataSources by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List dataSources resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn abandon_backup(requestId?: any)

abandon backup

Argument	Type	Required	Description
requestId?	any	no

fn fetch_access_token(generationId?: any)

fetch access token

Argument	Type	Required	Description
generationId?	any	no

fn finalize_backup(backupId?: any, consistencyTime?: any, description?: any, recoveryRangeEndTime?: any, recoveryRangeStartTime?: any, requestId?: any, retentionDuration?: any)

finalize backup

Argument	Type	Required
backupId?	any	no
consistencyTime?	any	no
description?	any	no
recoveryRangeEndTime?	any	no
recoveryRangeStartTime?	any	no
requestId?	any	no
retentionDuration?	any	no

fn initiate_backup(backupId?: any, requestId?: any)

initiate backup

Argument	Type	Required	Description
backupId?	any	no
requestId?	any	no

fn set_internal_status(backupConfigState?: any, requestId?: any, value?: any)

set internal status

Argument	Type	Required
backupConfigState?	any	no
requestId?	any	no
value?	any	no

Resources

state(infinite)— Message describing a DataSource object. Datasource object used to represent D...

backupvaults_datasources_backups.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
alloyDbBackupProperties?	object	no	Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
backupApplianceBackupProperties?	object	no	Output only. The time when this backup object was finalized (if none, backup is not finalized).
backupApplianceLocks?	array	no	Required. The ID of the backup/recovery appliance that created this lock.
backupRetentionInheritance?	enum	no	Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
backupType?	enum	no	Output only. Type of the backup, unspecified, scheduled or ondemand.
cloudSqlInstanceBackupProperties?	object	no	Output only. The installed database version of the Cloud SQL instance when the backup was taken.
computeInstanceBackupProperties?	object	no	Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
consistencyTime?	string	no	Output only. The point in time when this backup was captured from the source.
createTime?	string	no	Output only. The time when the instance was created.
description?	string	no	Output only. The description of the Backup instance (2048 characters or less).
diskBackupProperties?	object	no	The access mode of the source disk.
enforcedRetentionEndTime?	string	no	Optional. The backup can not be deleted before this time.
etag?	string	no	Optional. Server specified ETag to prevent updates from overwriting each other.
expireTime?	string	no	Optional. When this backup is automatically expired.
filestoreInstanceBackupProperties?	object	no	Output only. The source instance of the backup.
gcpBackupPlanInfo?	object	no	Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
gcpResource?	object	no	Name of the Google Cloud resource.
kmsKeyVersions?	array	no	Optional. Output only. The list of KMS key versions used to encrypt the backup.
labels?	record	no	Optional. Resource labels to represent user provided metadata. No labels currently defined.
name?	string	no	Output 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.
netappVolumeBackupProperties?	object	no	Output only. The source volume of the Backup.
resourceSizeBytes?	string	no	Output only. source resource size in bytes at the time of the backup.
satisfiesPzi?	boolean	no	Optional. Output only. Reserved for future use.
satisfiesPzs?	boolean	no	Optional. Output only. Reserved for future use.
serviceLocks?	array	no	Required. The ID of the backup/recovery appliance that created this lock.
state?	enum	no	Output only. The Backup resource instance state.
updateTime?	string	no	Output only. The time when the instance was updated.
requestId?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a backups

Argument	Type	Required	Description
identifier	string	yes	The name of the backups

fn update(identifier?: string, waitForReady?: boolean)

Update backups attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific backups by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the backups

Argument	Type	Required	Description
identifier	string	yes	The name of the backups

fn sync(identifier?: string)

Sync backups state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific backups by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List backups resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
view?	string	no	Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_for_resource_type(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any, resourceType?: any, view?: any)

fetch for resource type

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no
resourceType?	any	no
view?	any	no

fn restore(clearOverridesFieldMask?: any, computeInstanceRestoreProperties?: any, computeInstanceTargetEnvironment?: any, diskRestoreProperties?: any, diskTargetEnvironment?: any, regionDiskTargetEnvironment?: any, requestId?: any)

restore

Argument	Type	Required
clearOverridesFieldMask?	any	no
computeInstanceRestoreProperties?	any	no
computeInstanceTargetEnvironment?	any	no
diskRestoreProperties?	any	no
diskTargetEnvironment?	any	no
regionDiskTargetEnvironment?	any	no
requestId?	any	no

Resources

state(infinite)— Message describing a Backup object.

datasourcereferences.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a dataSourceReferences

Argument	Type	Required	Description
identifier	string	yes	The name of the dataSourceReferences

fn sync(identifier?: string)

Sync dataSourceReferences state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dataSourceReferences by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List dataSourceReferences resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename
pageSize?	number	no	Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_for_resource_type(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any, resourceType?: any)

fetch for resource type

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no
resourceType?	any	no

Resources

state(infinite)— DataSourceReference is a reference to a DataSource resource.

locations.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
name	string	yes	The resource that owns the locations collection, if applicable.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync(identifier?: string)

Sync locations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific locations by name (e.g. one discovered by list)

fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)

List locations resources

Argument	Type	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_trial()

get trial

Resources

state(infinite)— A resource that represents a Google Cloud location.

managementservers.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
description?	string	no	Optional. The description of the ManagementServer instance (2048 characters or less).
labels?	record	no	Optional. 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.
networks?	array	no	Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
type?	enum	no	Optional. The type of the ManagementServer resource.
managementServerId?	string	no	Required. The name of the management server to create. The name must be unique for the specified project and location.
requestId?	string	no	Optional. 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 was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a managementServers

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a managementServers

Argument	Type	Required	Description
identifier	string	yes	The name of the managementServers

fn delete(identifier: string)

Delete the managementServers

Argument	Type	Required	Description
identifier	string	yes	The name of the managementServers

fn sync(identifier?: string)

Sync managementServers state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific managementServers by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List managementServers resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn ms_compliance_metadata(projectId?: any)

ms compliance metadata

Argument	Type	Required	Description
projectId?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

Resources

state(infinite)— ManagementServer describes a single BackupDR ManagementServer instance.

resourcebackupconfigs.tsv2026.10.23.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a resourceBackupConfigs

Argument	Type	Required	Description
identifier	string	yes	The name of the resourceBackupConfigs

fn sync(identifier?: string)

Sync resourceBackupConfigs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific resourceBackupConfigs by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List resourceBackupConfigs resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filtering results.
orderBy?	string	no	Optional. Hint for how to order the results.
pageSize?	number	no	Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)

fetch

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no

Resources

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

04Previous Versions19

2026.10.22.1AGPL-3.0-or-laterOct 22, 2026

Added: appliedautoprotectionpolicies, autoprotectionpolicies, autoprotectionpolicies_bindings, autoprotectionpolicies_bindings_matchingresources
Updated: backupplanassociations, backupvaults_datasources

2026.10.15.1AGPL-3.0-or-later(was none)Oct 19, 2026

Updated: backupplanassociations, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences

2026.10.13.1Oct 13, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.10.08.1Oct 8, 2026

Updated: backupvaults_datasources

Modified 1 behaviors

2026.09.07.2Sep 8, 2026

Updated: managementservers

2026.08.12.2Aug 12, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.07.29.1Jul 30, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.07.24.1Jul 24, 2026

Updated: backupvaults

2026.07.21.3Jul 21, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.07.21.1Jul 21, 2026

Updated: backupplanassociations, backupplans, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, managementservers

2026.07.20.2Jul 20, 2026

Updated: locations, backupplans, resourcebackupconfigs

Modified 1 behaviors

2026.07.20.1Jul 20, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

Modified 1 behaviors

2026.07.19.2Jul 19, 2026

Updated: locations

2026.07.19.1Jul 19, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.07.18.2Jul 18, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

2026.07.17.2Jul 17, 2026

Updated: backupplanassociations, backupplans, backupvaults, backupvaults_datasources, backupvaults_datasources_backups

2026.07.17.1Jul 17, 2026

Updated: backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers

Added 1, removed 10 behaviors

2026.07.02.1Jul 2, 2026

Updated: backupplans

2026.06.08.2Jun 8, 2026

Updated: locations, backupplanassociations, backupplans, backupplans_revisions, backupvaults, backupvaults_datasources, backupvaults_datasources_backups, datasourcereferences, managementservers, resourcebackupconfigs

05Stats

100 / 100

Downloads

Archive size

173.7 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #backupdr #cloud #infrastructure