Skip to main content

Gcp/composer

@swamp/gcp/composerv2026.10.24.1· AGPL-3.0-or-later· 2d agoBEHAVIORS
01README

Google Cloud composer infrastructure models

02Release Notes
  • Updated: imageversions
03Behaviors5
@swamp/gcp/composer/environmentsv2026.10.23.1environments.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
config?objectOptional. Configuration parameters for this environment.
labels?recordOptional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
mode?enumOptional. Selects the environment mode that determines what settings are customizable and what features are available in the environment.
name?stringIdentifier. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
state?enumThe current state of the environment.
storageConfig?objectOptional. Storage configuration for this environment.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a environments
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a environments
ArgumentTypeDescription
identifierstringThe name of the environments
fn update(identifier?: string, waitForReady?: boolean)
Update environments attributes
ArgumentTypeDescription
identifier?stringTarget a specific environments by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the environments
ArgumentTypeDescription
identifierstringThe name of the environments
fn sync(identifier?: string)
Sync environments state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific environments by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List environments resources
ArgumentTypeDescription
pageSize?numberThe maximum number of environments to return.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn check_upgrade(imageVersion?: any)
check upgrade
ArgumentTypeDescription
imageVersion?any
fn database_failover()
database failover
fn execute_airflow_command(command?: any, parameters?: any, subcommand?: any)
execute airflow command
ArgumentTypeDescription
command?any
parameters?any
subcommand?any
fn fetch_database_properties()
fetch database properties
fn load_snapshot(skipAirflowOverridesSetting?: any, skipEnvironmentVariablesSetting?: any, skipGcsDataCopying?: any, skipPypiPackagesInstallation?: any, snapshotPath?: any)
load snapshot
ArgumentTypeDescription
skipAirflowOverridesSetting?any
skipEnvironmentVariablesSetting?any
skipGcsDataCopying?any
skipPypiPackagesInstallation?any
snapshotPath?any
fn poll_airflow_command(executionId?: any, nextLineNumber?: any, pod?: any, podNamespace?: any)
poll airflow command
ArgumentTypeDescription
executionId?any
nextLineNumber?any
pod?any
podNamespace?any
fn restart_web_server()
restart web server
fn save_snapshot(snapshotLocation?: any)
save snapshot
ArgumentTypeDescription
snapshotLocation?any
fn stop_airflow_command(executionId?: any, force?: any, pod?: any, podNamespace?: any)
stop airflow command
ArgumentTypeDescription
executionId?any
force?any
pod?any
podNamespace?any

Resources

state(infinite)— An environment for running orchestration tasks.
@swamp/gcp/composer/environments-userworkloadsconfigmapsv2026.10.23.1environments_userworkloadsconfigmaps.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
data?recordOptional. The "data" field of Kubernetes ConfigMap, organized in key-value pairs. For details see: https://kubernetes.io/docs/concepts/configuration/configmap/ Example: { "example_key": "example_value", "another_key": "another_value" }
name?stringIdentifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a userWorkloadsConfigMaps
fn get(identifier: string)
Get a userWorkloadsConfigMaps
ArgumentTypeDescription
identifierstringThe name of the userWorkloadsConfigMaps
fn update(identifier?: string)
Update userWorkloadsConfigMaps attributes
ArgumentTypeDescription
identifier?stringTarget a specific userWorkloadsConfigMaps by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the userWorkloadsConfigMaps
ArgumentTypeDescription
identifierstringThe name of the userWorkloadsConfigMaps
fn sync(identifier?: string)
Sync userWorkloadsConfigMaps state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific userWorkloadsConfigMaps by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List userWorkloadsConfigMaps resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of ConfigMaps to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— User workloads ConfigMap used by Airflow tasks that run with Kubernetes execu...
@swamp/gcp/composer/environments-userworkloadssecretsv2026.10.23.1environments_userworkloadssecrets.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
data?recordOptional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" }
name?stringIdentifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a userWorkloadsSecrets
fn get(identifier: string)
Get a userWorkloadsSecrets
ArgumentTypeDescription
identifierstringThe name of the userWorkloadsSecrets
fn update(identifier?: string)
Update userWorkloadsSecrets attributes
ArgumentTypeDescription
identifier?stringTarget a specific userWorkloadsSecrets by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the userWorkloadsSecrets
ArgumentTypeDescription
identifierstringThe name of the userWorkloadsSecrets
fn sync(identifier?: string)
Sync userWorkloadsSecrets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific userWorkloadsSecrets by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List userWorkloadsSecrets resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of Secrets to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— User workloads Secret used by Airflow tasks that run with Kubernetes executor...
@swamp/gcp/composer/environments-workloadsv2026.10.23.1environments_workloads.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a workloads
ArgumentTypeDescription
identifierstringThe name of the workloads
fn sync(identifier?: string)
Sync workloads state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific workloads by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List workloads resources
ArgumentTypeDescription
filter?stringOptional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It\
pageSize?numberOptional. The maximum number of environments to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Information about a single workload.
@swamp/gcp/composer/imageversionsv2026.10.24.1imageversions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP 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?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a imageVersions
ArgumentTypeDescription
identifierstringThe name of the imageVersions
fn sync(identifier?: string)
Sync imageVersions state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific imageVersions by name (e.g. one discovered by list)
fn list(includePastReleases?: boolean, pageSize?: number, maxPages?: number)
List imageVersions resources
ArgumentTypeDescription
includePastReleases?booleanWhether or not image versions from old releases should be included.
pageSize?numberThe maximum number of image_versions to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— ImageVersion information
04Previous Versions19
2026.10.23.3AGPL-3.0-or-later
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.10.23.1AGPL-3.0-or-later
  • Updated: imageversions
2026.10.15.1AGPL-3.0-or-later(was none)
  • Updated: environments
2026.10.13.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.09.29.1
  • Updated: environments_userworkloadsconfigmaps, environments_userworkloadssecrets
2026.08.29.1
  • Updated: environments
2026.08.12.2
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.29.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.21.4
  • Updated: environments
2026.07.21.1
  • Updated: environments
2026.07.20.2
  • Updated: environments
2026.07.20.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.19.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.18.2
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.07.17.2
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets
2026.07.17.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads
2026.07.03.1
  • Updated: environments
2026.06.08.2
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
2026.06.07.1
  • Updated: environments, environments_userworkloadsconfigmaps, environments_userworkloadssecrets, environments_workloads, imageversions
05Stats
A
100 / 100
Downloads
35
Archive size
76.9 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
06Platforms
07Labels