Gcp/cloudresourcemanager
@swamp/gcp/cloudresourcemanagerv2026.07.21.3
01README
Google Cloud cloudresourcemanager infrastructure models
02Release Notes
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
03Models
@swamp/gcp/cloudresourcemanager/capabilitiesv2026.07.21.2capabilities.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| name? | string | Immutable. Identifier. The resource name of the capability. Must be in the following form: * `folders/{folder_id}/capabilities/{capability_name}` For example, `folders/123/capabilities/app-management` Following are the allowed {capability_name} values: * `app-management` |
| value? | boolean | Required. The configured value of the capability at the given parent resource. |
fn get(identifier: string)
Get a capabilities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the capabilities |
fn update(identifier?: string)
Update capabilities attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific capabilities by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync capabilities state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific capabilities by name (e.g. one discovered by list) |
Resources
state(infinite)— Representation of a Capability.
@swamp/gcp/cloudresourcemanager/effectivetagbindingcollectionsv2026.07.21.2effectivetagbindingcollections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a effectiveTagBindingCollections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the effectiveTagBindingCollections |
fn sync(identifier?: string)
Sync effectiveTagBindingCollections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific effectiveTagBindingCollections by name (e.g. one discovered by list) |
Resources
state(infinite)— Represents a collection of effective tag bindings for a GCP resource.
@swamp/gcp/cloudresourcemanager/effectivetagsv2026.07.21.2effectivetags.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a effectiveTags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the effectiveTags |
fn sync(identifier?: string)
Sync effectiveTags state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific effectiveTags by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, maxPages?: number)
List effectiveTags resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of effective tags to return in the response. The server allows a maximum of 300 effective tags to return in a single page. If unspecified, the server will use 100 as the default. |
| parent? | string | Required. The full resource name of a resource for which you want to list the effective tags. E.g. "//cloudresourcemanager.googleapis.com/projects/123" |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An EffectiveTag represents a tag that applies to a resource during policy eva...
@swamp/gcp/cloudresourcemanager/foldersv2026.07.21.2folders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| displayName? | string | The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?`. |
| name? | string | Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234". |
| parent? | string | Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as ": ". For example: "123/environment": "production", "123/costCenter": "marketing" Note: Currently this field is in Preview. |
fn create(waitForReady?: boolean)
Create a folders
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn update(identifier?: string, waitForReady?: boolean)
Update folders attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific folders by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn sync(identifier?: string)
Sync folders state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific folders by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, showDeleted?: boolean, maxPages?: number)
List folders resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default. |
| parent? | string | Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. |
| showDeleted? | boolean | Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn move(destinationParent?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationParent? | any |
fn search()
search
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
fn undelete()
undelete
Resources
state(infinite)— A folder in an organization's resource hierarchy, used to organize that organ...
@swamp/gcp/cloudresourcemanager/liensv2026.07.21.2liens.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| createTime? | string | The creation time of this Lien. |
| name? | string | A system-generated unique identifier for this Lien. Example: `liens/1234abcd` |
| origin? | string | A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' |
| parent? | string | A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234` |
| reason? | string | Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' |
| restrictions? | array | The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] |
fn create()
Create a liens
fn get(identifier: string)
Get a liens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liens |
fn delete(identifier: string)
Delete the liens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the liens |
fn sync(identifier?: string)
Sync liens state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific liens by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, maxPages?: number)
List liens resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default. |
| parent? | string | Required. The name of the resource to list all attached Liens. For example, `projects/1234`. (google.api.field_policy).resource_type annotation is not set since the parent depends on the meta api implementation. This field could be a project or other sub project resources. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Lien represents an encumbrance on the actions that can be performed on a re...
@swamp/gcp/cloudresourcemanager/organizationsv2026.07.21.2organizations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a organizations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the organizations |
fn sync(identifier?: string)
Sync organizations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific organizations by name (e.g. one discovered by list) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn search()
search
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— The root node in the resource hierarchy to which a particular entity's (a com...
@swamp/gcp/cloudresourcemanager/projectsv2026.07.21.2projects.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| displayName? | string | Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` |
| labels? | record | Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific chara |
| parent? | string | Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. |
| projectId? | string | Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123` |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as ": ". For example: "123/environment": "production", "123/costCenter": "marketing" Note: Currently this field is in Preview. |
fn create(waitForReady?: boolean)
Create a projects
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a projects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the projects |
fn update(identifier?: string, waitForReady?: boolean)
Update projects attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific projects by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the projects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the projects |
fn sync(identifier?: string)
Sync projects state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific projects by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, showDeleted?: boolean, maxPages?: number)
List projects resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. |
| parent? | string | Required. The name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`. |
| showDeleted? | boolean | Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn move(destinationParent?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationParent? | any |
fn search()
search
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
fn undelete()
undelete
Resources
state(infinite)— A project is a high-level Google Cloud entity. It is a container for ACLs, AP...
@swamp/gcp/cloudresourcemanager/tagbindingcollectionsv2026.07.21.2tagbindingcollections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| etag? | string | Optional. A checksum based on the current bindings which can be passed to prevent race conditions. This field is always set in server responses. |
| fullResourceName? | string | The full resource name of the resource the TagBindings are bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123` |
| name? | string | Identifier. The name of the TagBindingCollection, following the convention: `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name of the GCP resource the TagBindings are bound to. "locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123" |
| tags? | record | Tag keys/values directly bound to this resource, specified in namespaced format. For example: "123/environment": "production" |
fn get(identifier: string)
Get a tagBindingCollections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagBindingCollections |
fn update(identifier?: string)
Update tagBindingCollections attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagBindingCollections by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync tagBindingCollections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagBindingCollections by name (e.g. one discovered by list) |
Resources
state(infinite)— Represents a collection of tags directly bound to a GCP resource.
@swamp/gcp/cloudresourcemanager/tagbindingsv2026.07.21.3tagbindings.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| parent? | string | The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123` |
| tagValue? | string | The TagValue of the TagBinding. Must be of the form `tagValues/456`. |
| tagValueNamespacedName? | string | The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected. |
fn create()
Create a tagBindings
fn get(identifier: string)
Get a tagBindings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagBindings |
fn delete(identifier: string)
Delete the tagBindings
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagBindings |
fn sync(identifier?: string)
Sync tagBindings state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagBindings by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, maxPages?: number)
List tagBindings resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default. |
| parent? | string | Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123" |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A TagBinding represents a connection between a TagValue and a cloud resource....
@swamp/gcp/cloudresourcemanager/tagkeysv2026.07.21.2tagkeys.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| allowedValuesRegex? | string | Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex). |
| description? | string | Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. |
| name? | string | Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey. |
| parent? | string | Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`. |
| purpose? | enum | Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set. |
| purposeData? | record | Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set. |
| shortName? | string | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
fn create()
Create a tagKeys
fn get(identifier: string)
Get a tagKeys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagKeys |
fn update(identifier?: string)
Update tagKeys attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagKeys by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the tagKeys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagKeys |
fn sync(identifier?: string)
Sync tagKeys state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagKeys by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, maxPages?: number)
List tagKeys resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default. |
| parent? | string | Required. The resource name of the TagKey's parent. Must be of the form `organizations/{org_id}` or `projects/{project_id}` or `projects/{project_number}` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn get_namespaced()
get namespaced
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A TagKey, used to group a set of TagValues.
@swamp/gcp/cloudresourcemanager/tagvaluesv2026.07.21.2tagvalues.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write. |
| name? | string | Immutable. Resource name for TagValue in the format `tagValues/456`. |
| parent? | string | Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form `tagKeys/{tag_key_id}`. |
| shortName? | string | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
fn create()
Create a tagValues
fn get(identifier: string)
Get a tagValues
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagValues |
fn update(identifier?: string)
Update tagValues attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagValues by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the tagValues
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagValues |
fn sync(identifier?: string)
Sync tagValues state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagValues by name (e.g. one discovered by list) |
fn list(pageSize?: number, parent?: string, maxPages?: number)
List tagValues resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of TagValues to return in the response. The server allows a maximum of 300 TagValues to return. If unspecified, the server will use 100 as the default. |
| parent? | string | Required. Resource name for the parent of the TagValues to be listed, in the format `tagKeys/123` or `tagValues/123`. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn get_namespaced()
get namespaced
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A TagValue is a child of a particular TagKey. This is used to group cloud res...
@swamp/gcp/cloudresourcemanager/tagvalues-tagholdsv2026.07.21.3tagvalues_tagholds.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| helpLink? | string | Optional. A URL where an end user can learn more about removing this hold. E.g. `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing` |
| holder? | string | Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g. `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` |
| origin? | string | Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g. `migs-35678234` |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a tagHolds
fn get(identifier: string)
Get a tagHolds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagHolds |
fn delete(identifier: string)
Delete the tagHolds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tagHolds |
fn sync(identifier?: string)
Sync tagHolds state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tagHolds by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List tagHolds resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the `holder` and `origin` fields are supported for filtering. Currently only `AND` syntax is supported. Some example queries are: * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/i |
| pageSize? | number | Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A TagHold represents the use of a TagValue that is not captured by TagBinding...
04Previous Versions
2026.07.21.1
- Updated: tagbindings, tagvalues_tagholds
2026.07.20.1
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.07.19.1
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.07.18.2
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.07.17.1
- Updated: folders, capabilities, liens, tagbindingcollections, projects, tagkeys, tagvalues
2026.07.16.1
- Updated: projects
2026.06.08.2
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.06.07.1
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.05.27.1
- Updated: tagkeys, tagvalues
2026.05.25.2
- Updated: effectivetags, folders, liens, projects, tagbindings, tagkeys, tagvalues
Modified 8 models
2026.05.24.1
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.05.21.6
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.05.21.5
Modified 5 models
2026.05.21.4
2026.05.19.2
2026.05.19.1
2026.04.23.1
2026.04.03.3
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
2026.04.03.1
- Updated: effectivetags, folders, capabilities, liens, effectivetagbindingcollections, tagbindingcollections, organizations, projects, tagbindings, tagkeys, tagvalues, tagvalues_tagholds
05Stats
A
100 / 100
Downloads
38
Archive size
115.6 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels