Skip to main content
← back to extensions

@swamp/gcp/notebooks

v2026.04.23.1

Google Cloud notebooks infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudnotebookscloudinfrastructure

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

@swamp/gcp/notebooks/instancesv2026.04.23.1instances.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
disableProxyAccess?booleanOptional. If true, the notebook instance will not register with the proxy.
enableDeletionProtection?booleanOptional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.
enableManagedEuc?booleanOptional. Flag to enable managed end user credentials for the instance.
enableThirdPartyIdentity?booleanOptional. Flag that specifies that a notebook can be accessed with third party identity provider.
gceSetup?objectThe definition of how to configure a VM instance outside of Resources and Identity.
instanceOwners?arrayOptional. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
labels?recordOptional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
instanceId?stringRequired. User-defined unique ID of this instance.
requestId?stringOptional. Idempotent request UUID.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a instances
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
updateUpdate instances attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
syncSync instances state from GCP
check_authorizationcheck authorization
ArgumentTypeDescription
authorizationDetails?any
check_upgradabilitycheck upgradability
diagnosediagnose
ArgumentTypeDescription
diagnosticConfig?any
timeoutMinutes?any
generate_access_tokengenerate access token
ArgumentTypeDescription
vmToken?any
get_configget config
report_info_systemreport info system
ArgumentTypeDescription
event?any
vmId?any
resetreset
resize_diskresize disk
ArgumentTypeDescription
bootDisk?any
dataDisk?any
restorerestore
ArgumentTypeDescription
snapshot?any
rollbackrollback
ArgumentTypeDescription
revisionId?any
targetSnapshot?any
startstart
stopstop
upgradeupgrade
upgrade_systemupgrade system
ArgumentTypeDescription
vmId?any

Resources

state(infinite)— The definition of a notebook instance.
@swamp/gcp/notebooks/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.