Skip to main content

Gcp/gkehub

@swamp/gcp/gkehubv2026.09.12.1· 2d agoMODELS
01README

Google Cloud gkehub infrastructure models

02Release Notes
  • Updated: rollouts
03Models12
@swamp/gcp/gkehub/featuresv2026.09.07.2features.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
fleetDefaultMemberConfig?objectOptional. Feature configuration applicable to all memberships of the fleet.
labels?recordLabels for this Feature.
membershipSpecs?recordOptional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is a
scopeSpecs?recordOptional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the ma
spec?objectOptional. Fleet-wide Feature configuration. If this Feature does not support any Fleet-wide configuration, this field may be unused.
featureId?stringThe ID of the feature to create.
requestId?stringA request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a features
fn get(identifier: string)
Get a features
ArgumentTypeDescription
identifierstringThe name of the features
fn update(identifier?: string)
Update features attributes
ArgumentTypeDescription
identifier?stringTarget a specific features by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the features
ArgumentTypeDescription
identifierstringThe name of the features
fn sync(identifier?: string)
Sync features state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific features by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List features resources
ArgumentTypeDescription
filter?stringLists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar
orderBy?stringOne or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
pageSize?numberWhen requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
returnPartialSuccess?booleanOptional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— Feature represents the settings and status of any Fleet Feature.
@swamp/gcp/gkehub/fleetsv2026.08.12.2fleets.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn get(identifier: string)
Get a fleets
ArgumentTypeDescription
identifierstringThe name of the fleets
fn sync(identifier?: string)
Sync fleets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific fleets by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List fleets resources
ArgumentTypeDescription
pageSize?numberOptional. The maximum number of fleets to return. The service may return fewer than this value. If unspecified, at most 200 fleets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Fleet contains the Fleet-wide metadata and configuration.
@swamp/gcp/gkehub/locationsv2026.08.12.2locations.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/gkehub/membershipsv2026.09.07.2memberships.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
authority?objectOptional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
endpoint?objectOptional. Endpoint information to reach this member.
externalId?stringOptional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object.
labels?recordOptional. Labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.
monitoringConfig?objectOptional. The monitoring config information for this membership.
membershipId?stringRequired. Client chosen ID for the membership. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
requestId?stringOptional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a memberships
fn get(identifier: string)
Get a memberships
ArgumentTypeDescription
identifierstringThe name of the memberships
fn update(identifier?: string)
Update memberships attributes
ArgumentTypeDescription
identifier?stringTarget a specific memberships by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the memberships
ArgumentTypeDescription
identifierstringThe name of the memberships
fn sync(identifier?: string)
Sync memberships state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific memberships by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List memberships resources
ArgumentTypeDescription
filter?stringOptional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING
orderBy?stringOptional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn generate_connect_manifest(imagePullSecretContent?: any, isUpgrade?: any, namespace?: any, proxy?: any, registry?: any, version?: any)
generate connect manifest
ArgumentTypeDescription
imagePullSecretContent?any
isUpgrade?any
namespace?any
proxy?any
registry?any
version?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— Membership contains information about a member cluster.
@swamp/gcp/gkehub/memberships-bindingsv2026.08.12.2memberships_bindings.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
labels?recordOptional. Labels for this MembershipBinding.
name?stringThe resource name for the membershipbinding itself `projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}`
scope?stringA Scope resource name in the format `projects/*/locations/*/scopes/*`.
membershipBindingId?stringRequired. The ID to use for the MembershipBinding.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a bindings
fn get(identifier: string)
Get a bindings
ArgumentTypeDescription
identifierstringThe name of the bindings
fn update(identifier?: string)
Update bindings attributes
ArgumentTypeDescription
identifier?stringTarget a specific bindings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the bindings
ArgumentTypeDescription
identifierstringThe name of the bindings
fn sync(identifier?: string)
Sync bindings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific bindings by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List bindings resources
ArgumentTypeDescription
filter?stringOptional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— MembershipBinding is a subresource of a Membership, representing what Fleet S...
@swamp/gcp/gkehub/memberships-featuresv2026.09.07.1memberships_features.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
labels?recordGoogle Cloud labels for this MembershipFeature.
spec?objectOptional. Spec of this membershipFeature.
featureId?stringRequired. The ID of the membership_feature to create.
requestId?stringIdempotent request UUID.
allowMissing?stringOptional. If set to true, and the MembershipFeature is not found, a new MembershipFeature will be created. In this situation, `update_mask` is ignored.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a features
fn get(identifier: string)
Get a features
ArgumentTypeDescription
identifierstringThe name of the features
fn update(identifier?: string)
Update features attributes
ArgumentTypeDescription
identifier?stringTarget a specific features by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the features
ArgumentTypeDescription
identifierstringThe name of the features
fn sync(identifier?: string)
Sync features state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific features by name (e.g. one discovered by list)
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List features resources
ArgumentTypeDescription
filter?stringLists MembershipFeatures that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "helloworld" in project "foo-proj" and membership "member-bar": name = "projects/foo-proj/locations/global/memberships/member-bar/features/helloworld" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar
orderBy?stringOne or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
pageSize?numberWhen requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— MembershipFeature represents the settings and status of a Fleet Feature enabl...
@swamp/gcp/gkehub/memberships-rbacrolebindingsv2026.09.07.1memberships_rbacrolebindings.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
group?stringgroup is the group, as seen by the kubernetes cluster.
labels?recordOptional. Labels for this RBACRolebinding.
name?stringThe resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
role?objectRequired. Role to bind to the principal
user?stringuser is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
rbacrolebindingId?stringRequired. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a rbacrolebindings
fn get(identifier: string)
Get a rbacrolebindings
ArgumentTypeDescription
identifierstringThe name of the rbacrolebindings
fn update(identifier?: string)
Update rbacrolebindings attributes
ArgumentTypeDescription
identifier?stringTarget a specific rbacrolebindings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the rbacrolebindings
ArgumentTypeDescription
identifierstringThe name of the rbacrolebindings
fn sync(identifier?: string)
Sync rbacrolebindings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rbacrolebindings by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List rbacrolebindings resources
ArgumentTypeDescription
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn generate_membership_rbacrole_binding_yaml(createTime?: any, deleteTime?: any, group?: any, labels?: any, name?: any, role?: any, state?: any, uid?: any, updateTime?: any, user?: any, rbacrolebindingId?: any)
generate membership rbacrole binding yaml
ArgumentTypeDescription
createTime?any
deleteTime?any
group?any
labels?any
name?any
role?any
state?any
uid?any
updateTime?any
user?any
rbacrolebindingId?any

Resources

state(infinite)— RBACRoleBinding represents a rbacrolebinding across the Fleet
@swamp/gcp/gkehub/rolloutsv2026.09.12.1rollouts.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn get(identifier: string)
Get a rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
fn delete(identifier: string)
Delete the rollouts
ArgumentTypeDescription
identifierstringThe name of the rollouts
fn sync(identifier?: string)
Sync rollouts state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rollouts by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List rollouts resources
ArgumentTypeDescription
filter?stringOptional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
pageSize?numberThe maximum number of rollout to return. The service may return fewer than this value. If unspecified, at most 50 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn cancel()
cancel
fn force_complete_stage(stageNumber?: any)
force complete stage
ArgumentTypeDescription
stageNumber?any
fn pause()
pause
fn resume(scheduleOffset?: any, validateOnly?: any)
resume
ArgumentTypeDescription
scheduleOffset?any
validateOnly?any

Resources

state(infinite)— Rollout contains the Rollout metadata and configuration. Next ID: 32
@swamp/gcp/gkehub/rolloutsequencesv2026.08.22.1rolloutsequences.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
autoUpgradeConfig?objectOptional. Configuration for automatic upgrades. If this message is `unset`, the system applies default behavior.
displayName?stringOptional. Human readable display name of the Rollout Sequence.
ignoredClustersSelector?objectOptional. Selector for clusters to exclude from the Rollout Sequence.
labels?recordOptional. Labels for this Rollout Sequence.
name?stringIdentifier. Name of the rollout sequence in the format of: projects/{PROJECT_ID}/locations/global/rolloutSequences/{NAME}
stages?arrayRequired. Ordered list of stages that constitutes this Rollout.
rolloutSequenceId?stringRequired. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a rolloutSequences
fn get(identifier: string)
Get a rolloutSequences
ArgumentTypeDescription
identifierstringThe name of the rolloutSequences
fn update(identifier?: string)
Update rolloutSequences attributes
ArgumentTypeDescription
identifier?stringTarget a specific rolloutSequences by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the rolloutSequences
ArgumentTypeDescription
identifierstringThe name of the rolloutSequences
fn sync(identifier?: string)
Sync rolloutSequences state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rolloutSequences by name (e.g. one discovered by list)
fn list(filter?: string, pageSize?: number, maxPages?: number)
List rolloutSequences resources
ArgumentTypeDescription
filter?stringOptional. Lists Rollout Sequences that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
pageSize?numberOptional. The maximum number of rollout sequences to return. The service may return fewer than this value. If unspecified, at most 50 rollout sequences will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn upgrade(force?: any, ignoreClusterDisruptionBudgets?: any, ignoreMaintenancePolicies?: any, patchOnly?: any, soakDurationOverrideAllStages?: any, soakDurationOverridePerStage?: any, upgradeType?: any, version?: any)
upgrade
ArgumentTypeDescription
force?any
ignoreClusterDisruptionBudgets?any
ignoreMaintenancePolicies?any
patchOnly?any
soakDurationOverrideAllStages?any
soakDurationOverridePerStage?any
upgradeType?any
version?any

Resources

state(infinite)— RolloutSequence defines the desired order of upgrades. Next ID: 20
@swamp/gcp/gkehub/scopesv2026.09.07.2scopes.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
labels?recordOptional. Labels for this Scope.
name?stringThe resource name for the scope `projects/{project}/locations/{location}/scopes/{scope}`
namespaceLabels?recordOptional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (`namespace_labels` in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.
scopeId?stringRequired. Client chosen ID for the Scope. `scope_id` must be a????
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a scopes
fn get(identifier: string)
Get a scopes
ArgumentTypeDescription
identifierstringThe name of the scopes
fn update(identifier?: string)
Update scopes attributes
ArgumentTypeDescription
identifier?stringTarget a specific scopes by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the scopes
ArgumentTypeDescription
identifierstringThe name of the scopes
fn sync(identifier?: string)
Sync scopes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific scopes by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List scopes resources
ArgumentTypeDescription
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn list_memberships(filter?: any, pageSize?: any, pageToken?: any)
list memberships
ArgumentTypeDescription
filter?any
pageSize?any
pageToken?any
fn list_permitted(pageSize?: any, pageToken?: any)
list permitted
ArgumentTypeDescription
pageSize?any
pageToken?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— Scope represents a Scope in a Fleet.
@swamp/gcp/gkehub/scopes-namespacesv2026.08.12.2scopes_namespaces.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
labels?recordOptional. Labels for this Namespace.
name?stringThe resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}`
namespaceLabels?recordOptional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant.
scope?stringRequired. Scope associated with the namespace
scopeNamespaceId?stringRequired. Client chosen ID for the Namespace. `namespace_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a namespaces
fn get(identifier: string)
Get a namespaces
ArgumentTypeDescription
identifierstringThe name of the namespaces
fn update(identifier?: string)
Update namespaces attributes
ArgumentTypeDescription
identifier?stringTarget a specific namespaces by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the namespaces
ArgumentTypeDescription
identifierstringThe name of the namespaces
fn sync(identifier?: string)
Sync namespaces state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific namespaces by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List namespaces resources
ArgumentTypeDescription
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Namespace represents a namespace across the Fleet
@swamp/gcp/gkehub/scopes-rbacrolebindingsv2026.08.12.2scopes_rbacrolebindings.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
group?stringgroup is the group, as seen by the kubernetes cluster.
labels?recordOptional. Labels for this RBACRolebinding.
name?stringThe resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
role?objectRequired. Role to bind to the principal
user?stringuser is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
rbacrolebindingId?stringRequired. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a rbacrolebindings
fn get(identifier: string)
Get a rbacrolebindings
ArgumentTypeDescription
identifierstringThe name of the rbacrolebindings
fn update(identifier?: string)
Update rbacrolebindings attributes
ArgumentTypeDescription
identifier?stringTarget a specific rbacrolebindings by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the rbacrolebindings
ArgumentTypeDescription
identifierstringThe name of the rbacrolebindings
fn sync(identifier?: string)
Sync rbacrolebindings state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific rbacrolebindings by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List rbacrolebindings resources
ArgumentTypeDescription
pageSize?numberOptional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— RBACRoleBinding represents a rbacrolebinding across the Fleet
04Previous Versions19
2026.09.07.2
  • Updated: features, memberships, scopes
2026.08.22.1
  • Updated: rolloutsequences, rollouts
2026.08.14.1
  • Updated: features
2026.08.12.2
  • Updated: locations, memberships_features, fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.08.07.1
  • Updated: rollouts
2026.07.29.1
  • Updated: locations, memberships_features, fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.07.25.1
  • Updated: memberships_features, features
2026.07.21.4
  • Added: fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
  • Updated: locations, memberships_features
2026.07.21.1
  • Updated: memberships_features, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.07.20.2
  • Added: fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
  • Updated: locations, memberships_features

Added 10 models

2026.07.20.1
  • Updated: locations, memberships_features

Removed 10 models

2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, memberships_features, fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.07.18.3
  • Updated: locations, memberships_features, fleets, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.07.18.1
  • Updated: memberships_features
2026.07.17.2
  • Updated: memberships_features, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.07.17.1
  • Updated: memberships_features, features, memberships, memberships_bindings, memberships_rbacrolebindings, rolloutsequences, rollouts, scopes, scopes_namespaces, scopes_rbacrolebindings
2026.06.27.1
  • Updated: memberships_features, features
2026.06.24.1
  • Added: rolloutsequences, rollouts
  • Updated: memberships_features

Added 12, removed 1 models

05Stats
A
100 / 100
Downloads
0
Archive size
220.9 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