Gcp/config
@swamp/gcp/configv2026.08.12.2
01README
Google Cloud config infrastructure models
02Release Notes
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
03Models
@swamp/gcp/config/deploymentgroupsv2026.08.12.2deploymentgroups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| annotations? | record | Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. |
| deploymentUnits? | array | The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned. |
| labels? | record | Optional. User-defined metadata for the deployment group. |
| name? | string | Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. |
| deploymentGroupId? | string | Required. The deployment group ID. |
| requestId? | string | 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 w |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a deploymentGroups
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a deploymentGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deploymentGroups |
fn update(identifier?: string, waitForReady?: boolean)
Update deploymentGroups attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deploymentGroups by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the deploymentGroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deploymentGroups |
fn sync(identifier?: string)
Sync deploymentGroups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deploymentGroups by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List deploymentGroups resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn deprovision(deletePolicy?: any, force?: any)
deprovision
| Argument | Type | Description |
|---|---|---|
| deletePolicy? | any | |
| force? | any |
fn provision(deletePolicy?: any, force?: any)
provision
| Argument | Type | Description |
|---|---|---|
| deletePolicy? | any | |
| force? | any |
Resources
state(infinite)— A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like struc...
@swamp/gcp/config/deploymentgroups-revisionsv2026.08.12.2deploymentgroups_revisions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a revisions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the revisions |
fn sync(identifier?: string)
Sync revisions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific revisions by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List revisions resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, a sensible default will be used by the server. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A DeploymentGroupRevision represents a snapshot of a DeploymentGroup at a giv...
@swamp/gcp/config/deploymentsv2026.08.12.2deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| annotations? | record | Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. |
| artifactsGcsBucket? | string | User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence |
| importExistingResources? | boolean | By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation. |
| labels? | record | Optional. User-defined metadata for the deployment. |
| name? | string | Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` |
| providerConfig? | object | Optional. This field specifies the provider configurations. |
| quotaValidation? | enum | Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies. |
| serviceAccount? | string | Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` |
| terraformBlueprint? | object | A blueprint described using Terraform's HashiCorp Configuration Language as a root module. |
| tfVersionConstraint? | string | The user-specified Terraform version constraint. Example: "=1.3.10". |
| workerPool? | string | The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used. |
| deploymentId? | string | Required. The Deployment ID. |
| requestId? | string | 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 w |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a deployments
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn update(identifier?: string, waitForReady?: boolean)
Update deployments attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployments by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync(identifier?: string)
Sync deployments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployments by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List deployments resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \ |
| orderBy? | string | Field to use to sort the list. |
| pageSize? | number | When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn export_lock()
export lock
fn export_state(draft?: any)
export state
| Argument | Type | Description |
|---|---|---|
| draft? | any |
fn get_iam_policy()
get iam policy
fn import_state(lockId?: any)
import state
| Argument | Type | Description |
|---|---|---|
| lockId? | any |
fn lock()
lock
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
fn unlock(lockId?: any)
unlock
| Argument | Type | Description |
|---|---|---|
| lockId? | any |
Resources
state(infinite)— A Deployment is a group of resources and configs managed and provisioned by I...
@swamp/gcp/config/deployments-revisionsv2026.08.12.2deployments_revisions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a revisions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the revisions |
fn sync(identifier?: string)
Sync revisions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific revisions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List revisions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Lists the Revisions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \ |
| orderBy? | string | Field to use to sort the list. |
| pageSize? | number | When requesting a page of resources, `page_size` specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn export_state()
export state
Resources
state(infinite)— A child resource of a Deployment generated by a 'CreateDeployment' or 'Update...
@swamp/gcp/config/deployments-revisions-resourcesv2026.08.12.2deployments_revisions_resources.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a resources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the resources |
fn sync(identifier?: string)
Sync resources state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific resources by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List resources resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Lists the Resources that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \ |
| orderBy? | string | Field to use to sort the list. |
| pageSize? | number | When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Resource represents a Google Cloud Platform resource actuated by IM. Resource...
@swamp/gcp/config/locationsv2026.08.12.2locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | 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 | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | 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 | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_auto_migration_config()
get auto migration config
fn update_auto_migration_config(autoMigrationEnabled?: any, name?: any, updateTime?: any)
update auto migration config
| Argument | Type | Description |
|---|---|---|
| autoMigrationEnabled? | any | |
| name? | any | |
| updateTime? | any |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/config/previewsv2026.08.12.2previews.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| annotations? | record | Optional. Arbitrary key-value metadata storage e.g. to help client tools identify preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. |
| artifactsGcsBucket? | string | User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used. |
| deployment? | string | Optional. Deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request. |
| labels? | record | Optional. User-defined labels for the preview. |
| name? | string | Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: `projects/{project}/locations/{location}/previews/{preview}` |
| previewMode? | enum | Optional. Current mode of preview. |
| providerConfig? | object | Optional. This field specifies the provider configurations. |
| serviceAccount? | string | Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` |
| terraformBlueprint? | object | The terraform blueprint to preview. |
| tfVersionConstraint? | string | The user-specified Terraform version constraint. Example: "=1.3.10". |
| workerPool? | string | The user-specified Worker Pool resource in which the Cloud Build job will execute. Format projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used. |
| previewId? | string | Optional. The preview ID. |
| requestId? | string | 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 w |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a previews
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a previews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the previews |
fn delete(identifier: string)
Delete the previews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the previews |
fn sync(identifier?: string)
Sync previews state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific previews by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List previews resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \ |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn export()
export
Resources
state(infinite)— A preview represents a set of actions Infra Manager would perform to move the...
@swamp/gcp/config/previews-resourcechangesv2026.08.12.2previews_resourcechanges.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a resourceChanges
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the resourceChanges |
fn sync(identifier?: string)
Sync resourceChanges state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific resourceChanges by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List resourceChanges resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. When requesting a page of resource changes, 'page_size' specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource change represents a change to a resource in the state file.
@swamp/gcp/config/previews-resourcedriftsv2026.08.12.2previews_resourcedrifts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a resourceDrifts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the resourceDrifts |
fn sync(identifier?: string)
Sync resourceDrifts state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific resourceDrifts by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List resourceDrifts resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the resource drifts that match the filter expression. A filter expression filters the resource drifts listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. When requesting a page of resource drifts, 'page_size' specifies number of resource drifts to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource drift represents a drift to a resource in the state file.
@swamp/gcp/config/terraformversionsv2026.08.12.2terraformversions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | 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 | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | 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 | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a terraformVersions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the terraformVersions |
fn sync(identifier?: string)
Sync terraformVersions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific terraformVersions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List terraformVersions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Lists the TerraformVersions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. |
| orderBy? | string | Optional. Field to use to sort the list. |
| pageSize? | number | Optional. When requesting a page of terraform versions, 'page_size' specifies number of terraform versions to return. If unspecified, at most 500 will be returned. The maximum value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A TerraformVersion represents the support state the corresponding Terraform v...
04Previous Versions
2026.08.01.1
- Updated: previews
2026.07.31.1
- Updated: previews
2026.07.29.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.07.21.4
- Updated: locations, deployments, previews
2026.07.21.1
- Updated: deploymentgroups, deployments, previews
2026.07.20.2
- Updated: locations, deployments, previews
2026.07.20.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.07.18.2
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.07.17.2
- Updated: deploymentgroups, deployments, previews
2026.07.17.1
- Updated: deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.06.24.1
- Updated: deployments, previews
2026.06.08.2
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.06.07.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.05.26.1
- Updated: locations
2026.05.25.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
Modified 10 models
2026.05.24.1
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
2026.05.21.2
- Updated: locations, deploymentgroups, deploymentgroups_revisions, deployments, deployments_revisions, deployments_revisions_resources, previews, previews_resourcechanges, previews_resourcedrifts, terraformversions
05Stats
A
100 / 100
Downloads
0
Archive size
107.2 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels