Skip to main content
← back to extensions

@swamp/gcp/config

v2026.04.23.1

Google Cloud config infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudconfigcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

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

Install

$ swamp extension pull @swamp/gcp/config

@swamp/gcp/config/deploymentgroupsv2026.04.23.1deploymentgroups.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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?arrayThe 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?recordOptional. User-defined metadata for the deployment group.
name?stringIdentifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
provisioningError?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
deploymentGroupId?stringRequired. The deployment group ID.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a deploymentGroups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a deploymentGroups
ArgumentTypeDescription
identifierstringThe name of the deploymentGroups
updateUpdate deploymentGroups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the deploymentGroups
ArgumentTypeDescription
identifierstringThe name of the deploymentGroups
syncSync deploymentGroups state from GCP
deprovisiondeprovision
ArgumentTypeDescription
deletePolicy?any
force?any
provisionprovision
ArgumentTypeDescription
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.04.23.1deploymentgroups_revisions.ts

Global Arguments

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

Resources

state(infinite)— A DeploymentGroupRevision represents a snapshot of a DeploymentGroup at a giv...
@swamp/gcp/config/deploymentsv2026.04.23.1deployments.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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?stringOptional. 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
deleteResults?objectOutputs and artifacts from applying a deployment.
importExistingResources?booleanBy 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?recordOptional. User-defined metadata for the deployment.
name?stringIdentifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
providerConfig?objectProviderConfig contains the provider configurations.
quotaValidation?enumOptional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
serviceAccount?stringRequired. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
terraformBlueprint?objectTerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed.
tfVersionConstraint?stringOptional. The user-specified Terraform version constraint. Example: "=1.3.10".
workerPool?stringOptional. 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?stringRequired. The Deployment ID.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a deployments
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a deployments
ArgumentTypeDescription
identifierstringThe name of the deployments
updateUpdate deployments attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the deployments
ArgumentTypeDescription
identifierstringThe name of the deployments
syncSync deployments state from GCP
export_lockexport lock
export_stateexport state
ArgumentTypeDescription
draft?any
import_stateimport state
ArgumentTypeDescription
lockId?any
locklock
unlockunlock
ArgumentTypeDescription
lockId?any

Resources

state(infinite)— A Deployment is a group of resources and configs managed and provisioned by I...
@swamp/gcp/config/deployments-revisionsv2026.04.23.1deployments_revisions.ts

Global Arguments

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

Resources

state(infinite)— A child resource of a Deployment generated by a 'CreateDeployment' or 'Update...
@swamp/gcp/config/deployments-revisions-resourcesv2026.04.23.1deployments_revisions_resources.ts

Global Arguments

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

Resources

state(infinite)— Resource represents a Google Cloud Platform resource actuated by IM. Resource...
@swamp/gcp/config/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP
get_auto_migration_configget auto migration config
update_auto_migration_configupdate auto migration config
ArgumentTypeDescription
autoMigrationEnabled?any
name?any
updateTime?any

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/config/previewsv2026.04.23.1previews.ts

Global Arguments

ArgumentTypeDescription
annotations?recordOptional. 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?stringOptional. 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?stringOptional. 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.
errorStatus?objectThe `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
labels?recordOptional. User-defined labels for the preview.
name?stringIdentifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: `projects/{project}/locations/{location}/previews/{preview}`
previewArtifacts?objectArtifacts created by preview.
previewMode?enumOptional. Current mode of preview.
providerConfig?objectProviderConfig contains the provider configurations.
serviceAccount?stringRequired. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
terraformBlueprint?objectTerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed.
tfVersionConstraint?stringOptional. The user-specified Terraform version constraint. Example: "=1.3.10".
workerPool?stringOptional. 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?stringOptional. The preview ID.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID w
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a previews
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a previews
ArgumentTypeDescription
identifierstringThe name of the previews
deleteDelete the previews
ArgumentTypeDescription
identifierstringThe name of the previews
syncSync previews state from GCP
exportexport

Resources

state(infinite)— A preview represents a set of actions Infra Manager would perform to move the...
@swamp/gcp/config/previews-resourcechangesv2026.04.23.1previews_resourcechanges.ts

Global Arguments

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

Resources

state(infinite)— A resource change represents a change to a resource in the state file.
@swamp/gcp/config/previews-resourcedriftsv2026.04.23.1previews_resourcedrifts.ts

Global Arguments

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

Resources

state(infinite)— A resource drift represents a drift to a resource in the state file.
@swamp/gcp/config/terraformversionsv2026.04.23.1terraformversions.ts

Global Arguments

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

Resources

state(infinite)— A TerraformVersion represents the support state the corresponding Terraform v...