Skip to main content

@swamp/gcp/appengine

v2026.04.23.1

Google Cloud appengine infrastructure models

Repository

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

Labels

gcpgoogle-cloudappenginecloudinfrastructure

Contents

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/appengine

apps_services_versions_instances.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
deleteDelete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
syncSync instances state from GCP
debugdebug
ArgumentTypeDescription
sshKey?any
applications_authorizedcertificates.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
certificateRawData?objectUnencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
displayName?stringThe user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount?numberAggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
expireTime?stringThe time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate?objectTime at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
projectsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
locationsIdstringPart of `parent`. See documentation of `projectsId`.
applicationsIdstringPart of `parent`. See documentation of `projectsId`.
createCreate a authorizedCertificates
getGet a authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
updateUpdate authorizedCertificates attributes
deleteDelete the authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
syncSync authorizedCertificates state from GCP
apps.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
authDomain?stringGoogle Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
databaseType?enumThe type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultCookieExpiration?stringCookie expiration policy for this application.
dispatchRules?arrayDomain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
featureSettings?objectBoolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap?objectWhether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
id?stringIdentifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
locationId?stringLocation from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name?string
serviceAccount?stringThe service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
servingStatus?enumServing status of this application.
sslPolicy?enumThe SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite
createCreate a apps
getGet a apps
ArgumentTypeDescription
identifierstringThe name of the apps
updateUpdate apps attributes
syncSync apps state from GCP
list_runtimeslist runtimes
repairrepair
apps_domainmappings.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
id?stringRelative name of the domain serving the application. Example: example.com.
sslSettings?objectID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
appsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
overrideStrategy?stringWhether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
createCreate a domainMappings
getGet a domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
updateUpdate domainMappings attributes
deleteDelete the domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
syncSync domainMappings state from GCP
applications_domainmappings.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
id?stringRelative name of the domain serving the application. Example: example.com.
sslSettings?objectID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
projectsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
locationsIdstringPart of `parent`. See documentation of `projectsId`.
applicationsIdstringPart of `parent`. See documentation of `projectsId`.
overrideStrategy?stringWhether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
createCreate a domainMappings
getGet a domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
updateUpdate domainMappings attributes
deleteDelete the domainMappings
ArgumentTypeDescription
identifierstringThe name of the domainMappings
syncSync domainMappings state from GCP
apps_authorizedcertificates.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
certificateRawData?objectUnencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
displayName?stringThe user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
domainMappingsCount?numberAggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
expireTime?stringThe time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
managedCertificate?objectTime at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
appsIdstringPart of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.
createCreate a authorizedCertificates
getGet a authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
updateUpdate authorizedCertificates attributes
deleteDelete the authorizedCertificates
ArgumentTypeDescription
identifierstringThe name of the authorizedCertificates
syncSync authorizedCertificates state from GCP
apps_authorizeddomains.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a authorizedDomains
ArgumentTypeDescription
identifierstringThe name of the authorizedDomains
syncSync authorizedDomains state from GCP
apps_services.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
id?stringOutput only. Relative name of the service within the application. Example: default.@OutputOnly
labels?recordA set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
name?stringOutput only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
networkSettings?objectThe ingress settings for version or service.
split?objectMapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
getGet a services
ArgumentTypeDescription
identifierstringThe name of the services
updateUpdate services attributes
deleteDelete the services
ArgumentTypeDescription
identifierstringThe name of the services
syncSync services state from GCP
applications_authorizeddomains.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a authorizedDomains
ArgumentTypeDescription
identifierstringThe name of the authorizedDomains
syncSync authorizedDomains state from GCP
apps_firewall_ingressrules.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
action?enumThe action to take on matched requests.
description?stringAn optional string description of this rule. This field has a maximum length of 400 characters.
priority?number
sourceRange?stringIP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
appsIdstringPart of `parent`. Required. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.
createCreate a ingressRules
getGet a ingressRules
ArgumentTypeDescription
identifierstringThe name of the ingressRules
updateUpdate ingressRules attributes
deleteDelete the ingressRules
ArgumentTypeDescription
identifierstringThe name of the ingressRules
syncSync ingressRules state from GCP
batch_updatebatch update
ArgumentTypeDescription
ingressRules?any
apps_services_versions.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
apiConfig?objectAction to take when users access resources that require authentication. Defaults to redirect.
appEngineApis?booleanAllows App Engine second generation runtimes to access the legacy bundled services.
automaticScaling?objectThe time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
basicScaling?objectDuration of time after the last request that an instance must wait before the instance is shut down.
betaSettings?recordMetadata settings that are supplied to this version to enable beta runtime features.
buildEnvVariables?recordEnvironment variables available to the build environment.Only returned in GET requests if view=FULL is set.
createTime?stringTime that this version was created.@OutputOnly
defaultExpiration?stringDuration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
deployment?objectPath to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
endpointsApiService?objectEndpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
entrypoint?objectThe format should be a shell command that can be fed to bash -c.
env?stringApp Engine execution environment for this version.Defaults to standard.
envVariables?recordEnvironment variables available to the application.Only returned in GET requests if view=FULL is set.
errorHandlers?arrayError condition this handler applies to.
flexibleRuntimeSettings?objectThe operating system of the application runtime.
generatedCustomerMetadata?recordAdditional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
handlers?arrayPath to the script from the application root directory.
healthCheck?objectInterval between health checks.
id?stringRelative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
inboundServices?arrayBefore an application can receive email or XMPP messages, the application must be configured to enable the service.
instanceClass?stringInstance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
libraries?arrayName of the library. Example: "django".
livenessCheck?objectInterval between health checks.
manualScaling?objectNumber of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
network?objectList of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
nobuildFilesRegex?stringFiles that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
readinessCheck?objectA maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
resources?objectNumber of CPU cores needed.
runtime?stringDesired runtime. Example: python27.
runtimeApiVersion?stringThe version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
runtimeChannel?stringThe channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
runtimeMainExecutablePath?stringThe path or name of the app's main executable.
serviceAccount?stringThe identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
servingStatus?enumCurrent serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
threadsafe?booleanWhether multiple requests can be dispatched to this version at once.
vm?booleanWhether to deploy this version in a container on a virtual machine.
vpcAccessConnector?objectThe egress setting for the connector, controlling what traffic is diverted through it.
zones?arrayThe Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
appsIdstringPart of `parent`. Required. Name of the parent resource to create this version under. Example: apps/myapp/services/default.
servicesIdstringPart of `parent`. See documentation of `appsId`.
createCreate a versions
getGet a versions
ArgumentTypeDescription
identifierstringThe name of the versions
updateUpdate versions attributes
deleteDelete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
syncSync versions state from GCP
export_app_imageexport app image
ArgumentTypeDescription
destinationRepository?any