Skip to main content
← back to extensions

@swamp/gcp/apigateway

v2026.04.23.1

Google Cloud apigateway infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudapigatewaycloudinfrastructure

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

@swamp/gcp/apigateway/apisv2026.04.23.1apis.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
displayName?stringOptional. Display name.
labels?recordOptional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
managedService?stringOptional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
apiId?stringRequired. Identifier to assign to the API. Must be unique within scope of the parent resource.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a apis
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a apis
ArgumentTypeDescription
identifierstringThe name of the apis
updateUpdate apis attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the apis
ArgumentTypeDescription
identifierstringThe name of the apis
syncSync apis state from GCP

Resources

state(infinite)— An API that can be served by one or more Gateways.
@swamp/gcp/apigateway/apis-configsv2026.04.23.1apis_configs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
displayName?stringOptional. Display name.
gatewayServiceAccount?stringImmutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.
grpcServices?arrayOptional. gRPC service definition files. If specified, openapi_documents must not be included.
labels?recordOptional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
managedServiceConfigs?arrayOptional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merge
openapiDocuments?arrayOptional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
apiConfigId?stringRequired. Identifier to assign to the API Config. Must be unique within scope of the parent resource.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a configs
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a configs
ArgumentTypeDescription
identifierstringThe name of the configs
updateUpdate configs attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the configs
ArgumentTypeDescription
identifierstringThe name of the configs
syncSync configs state from GCP

Resources

state(infinite)— An API Configuration is a combination of settings for both the Managed Servic...
@swamp/gcp/apigateway/gatewaysv2026.04.23.1gateways.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
apiConfig?stringRequired. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
displayName?stringOptional. Display name.
labels?recordOptional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
gatewayId?stringRequired. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a gateways
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a gateways
ArgumentTypeDescription
identifierstringThe name of the gateways
updateUpdate gateways attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the gateways
ArgumentTypeDescription
identifierstringThe name of the gateways
syncSync gateways state from GCP

Resources

state(infinite)— A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consu...
@swamp/gcp/apigateway/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

Resources

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