@swamp/gcp/file
v2026.04.23.1
Google Cloud file infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudfilecloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
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/file@swamp/gcp/file/backupsv2026.04.23.1backups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| description? | string | A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| kmsKey? | string | Immutable. KMS key name used for data encryption. |
| labels? | record | Resource labels to represent user provided metadata. |
| sourceFileShare? | string | Name of the file share in the source Filestore instance that the backup is created from. |
| sourceInstance? | string | The resource name of the source Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. |
| tags? | record | Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment": "production", "123456789013/costCenter": "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_ |
| backupId? | string | Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a backups
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
updateUpdate backups attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
syncSync backups state from GCP
Resources
state(infinite)— A Filestore backup.
@swamp/gcp/file/instancesv2026.04.23.1instances.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| deletionProtectionEnabled? | boolean | Optional. Indicates whether the instance is protected against deletion. |
| deletionProtectionReason? | string | Optional. The reason for enabling deletion protection. |
| description? | string | The description of the instance (2048 characters or less). |
| directoryServices? | object | Directory Services configuration for Kerberos-based authentication. |
| fileShares? | array | File system shares on the instance. For this version, only a single file share is supported. |
| kmsKeyName? | string | KMS key name used for data encryption. |
| labels? | record | Resource labels to represent user provided metadata. |
| networks? | array | VPC networks to which the instance is connected. For this version, only a single network is supported. |
| performanceConfig? | object | Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). |
| performanceLimits? | object | The enforced performance limits, calculated from the instance's performance configuration. |
| protocol? | enum | Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. |
| replication? | object | Optional. The configuration used to replicate an instance. |
| tags? | record | Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment": "production", "123456789013/costCenter": "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_ |
| tier? | enum | The service tier of the instance. |
| instanceId? | string | Required. The name of the instance to create. The name must be unique for the specified project and location. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
updateUpdate instances attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
syncSync instances state from GCP
pause_replicapause replica
promote_replicapromote replica
| Argument | Type | Description |
|---|---|---|
| peerInstance? | any |
restorerestore
| Argument | Type | Description |
|---|---|---|
| fileShare? | any | |
| sourceBackup? | any |
resume_replicaresume replica
revertrevert
| Argument | Type | Description |
|---|---|---|
| targetSnapshotId? | any |
Resources
state(infinite)— A Filestore instance.
@swamp/gcp/file/instances-snapshotsv2026.04.23.1instances_snapshots.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| description? | string | A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| labels? | record | Resource labels to represent user provided metadata. |
| tags? | record | Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment": "production", "123456789013/costCenter": "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_ |
| snapshotId? | string | Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a snapshots
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a snapshots
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snapshots |
updateUpdate snapshots attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the snapshots
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snapshots |
syncSync snapshots state from GCP
Resources
state(infinite)— A Filestore snapshot.
@swamp/gcp/file/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
Resources
state(infinite)— A resource that represents a Google Cloud location.
2026.04.04.132.6 KBApr 4, 2026
Google Cloud file infrastructure models
Release Notes
- Updated: instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudfilecloudinfrastructure
2026.04.03.332.6 KBApr 3, 2026
Google Cloud file infrastructure models
Release Notes
- Updated: locations, backups, instances, instances_snapshots
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudfilecloudinfrastructure
2026.04.03.132.3 KBApr 3, 2026
Google Cloud file infrastructure models
Release Notes
- Updated: locations, backups, instances, instances_snapshots
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudfilecloudinfrastructure
2026.04.02.232.3 KBApr 2, 2026
Google Cloud file infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudfilecloudinfrastructure
2026.03.27.130.3 KBMar 27, 2026
Google Cloud file infrastructure models
Release Notes
- Added: locations, backups, instances, instances_snapshots
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudfilecloudinfrastructure