Gcp/assuredworkloads

@swamp/gcp/assuredworkloadsv2026.10.29.1· AGPL-3.0-or-later· 2d agoBEHAVIORS

01README

Google Cloud assuredworkloads infrastructure models

02Release Notes

Updated: dbfindingsummaries, dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries, workloads_violations

03Behaviors6

@swamp/gcp/assuredworkloads/dbfindingsummariesv2026.10.29.1dbfindingsummaries.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a dbFindingSummaries

Argument	Type	Required	Description
identifier	string	yes	The name of the dbFindingSummaries

fn sync(identifier?: string)

Sync dbFindingSummaries state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dbFindingSummaries by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List dbFindingSummaries resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).
pageSize?	number	no	Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A summary of the active findings for a finding category in a Data Boundary sc...

@swamp/gcp/assuredworkloads/dbframeworkcompliancereports-dbcontrolcompliancesummariesv2026.10.29.1dbframeworkcompliancereports_dbcontrolcompliancesummaries.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a dbControlComplianceSummaries

Argument	Type	Required	Description
identifier	string	yes	The name of the dbControlComplianceSummaries

fn sync(identifier?: string)

Sync dbControlComplianceSummaries state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dbControlComplianceSummaries by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List dbControlComplianceSummaries resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = "2026-01-01T00:00:00Z"`. Only findings that were updated at or after this time are counted.
pageSize?	number	no	Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A summary of the compliance status of a control in a framework compliance rep...

@swamp/gcp/assuredworkloads/dbframeworkcompliancesummariesv2026.10.29.1dbframeworkcompliancesummaries.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a dbFrameworkComplianceSummaries

Argument	Type	Required	Description
identifier	string	yes	The name of the dbFrameworkComplianceSummaries

fn sync(identifier?: string)

Sync dbFrameworkComplianceSummaries state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific dbFrameworkComplianceSummaries by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)

List dbFrameworkComplianceSummaries resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that restricts the results. Reserved for future use.
pageSize?	number	no	Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.
view?	string	no	Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A summary of the compliance status of a framework that's deployed in a Data B...

@swamp/gcp/assuredworkloads/workloadsv2026.10.23.1workloads.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
billingAccount?	string	no	Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.
complianceRegime?	enum	no	Required. Immutable. Compliance Regime associated with this workload.
displayName?	string	no	Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
enableSovereignControls?	boolean	no	Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
labels?	record	no	Optional. Labels applied to the workload.
name?	string	no	Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
partner?	enum	no	Optional. Partner regime associated with this workload.
partnerPermissions?	object	no	Optional. Permissions granted to the AW Partner SA account for the customer workload
partnerServicesBillingAccount?	string	no	Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC
provisionedResourcesParent?	string	no	Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
resourceSettings?	array	no	Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
violationNotificationsEnabled?	boolean	no	Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
workloadOptions?	object	no	Optional. Options to be set for the given created workload.
externalId?	string	no	Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn create()

Create a workloads

fn get(identifier: string)

Get a workloads

Argument	Type	Required	Description
identifier	string	yes	The name of the workloads

fn update(identifier?: string)

Update workloads attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific workloads by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the workloads

Argument	Type	Required	Description
identifier	string	yes	The name of the workloads

fn sync(identifier?: string)

Sync workloads state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific workloads by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List workloads resources

Argument	Type	Required	Description
filter?	string	no	Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.
pageSize?	number	no	Optional. Page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn analyze_workload_move(assetTypes?: any, pageSize?: any, pageToken?: any, project?: any)

analyze workload move

Argument	Type	Required
assetTypes?	any	no
pageSize?	any	no
pageToken?	any	no
project?	any	no

fn enable_compliance_updates()

enable compliance updates

fn enable_resource_monitoring()

enable resource monitoring

fn mutate_partner_permissions(etag?: any, partnerPermissions?: any, updateMask?: any)

mutate partner permissions

Argument	Type	Required
etag?	any	no
partnerPermissions?	any	no
updateMask?	any	no

fn restrict_allowed_resources(restrictionType?: any)

restrict allowed resources

Argument	Type	Required	Description
restrictionType?	any	no

Resources

state(infinite)— A Workload object for managing highly regulated workloads of cloud customers.

@swamp/gcp/assuredworkloads/workloads-updatesv2026.10.23.1workloads_updates.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a updates

Argument	Type	Required	Description
identifier	string	yes	The name of the updates

fn sync(identifier?: string)

Sync updates state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific updates by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List updates resources

Argument	Type	Required	Description
pageSize?	number	no	Page size. The default value is 20 and the max allowed value is 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn apply(action?: any)

apply

Argument	Type	Required	Description
action?	any	no

Resources

state(infinite)— A workload update is a change to the workload's compliance configuration.

@swamp/gcp/assuredworkloads/workloads-violationsv2026.10.29.1workloads_violations.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP 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?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)

fn get(identifier: string)

Get a violations

Argument	Type	Required	Description
identifier	string	yes	The name of the violations

fn sync(identifier?: string)

Sync violations state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific violations by name (e.g. one discovered by list)

fn list(filter?: string, interval_endTime?: string, interval_startTime?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List violations resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `ass
interval_endTime?	string	no	The end of the time window.
interval_startTime?	string	no	The start of the time window.
orderBy?	string	no	Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order.
pageSize?	number	no	Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
view?	string	no	Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn acknowledge(acknowledgeType?: any, comment?: any, nonCompliantOrgPolicy?: any, view?: any)

acknowledge

Argument	Type	Required
acknowledgeType?	any	no
comment?	any	no
nonCompliantOrgPolicy?	any	no
view?	any	no

Resources

state(infinite)— A compliance violation that's detected by Assured Workloads monitoring. A vio...

04Previous Versions19

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: dbfindingsummaries, dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries, workloads, workloads_updates, workloads_violations

2026.10.13.1Oct 13, 2026

Updated: dbfindingsummaries, dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries, workloads, workloads_updates, workloads_violations

2026.10.02.1Oct 2, 2026

Updated: workloads_violations

2026.09.17.1Sep 17, 2026

Updated: dbframeworkcompliancereports_dbcontrolcompliancesummaries, workloads

2026.09.07.1Sep 8, 2026

Updated: workloads

2026.08.15.1Aug 15, 2026

Updated: dbfindingsummaries, workloads_violations

Modified 1 behaviors

2026.08.12.2Aug 12, 2026

Updated: dbfindingsummaries, dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries, workloads, workloads_updates, workloads_violations

2026.07.29.1Jul 30, 2026

Updated: dbfindingsummaries, dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries, workloads, workloads_updates, workloads_violations

2026.07.24.1Jul 24, 2026

Added: dbframeworkcompliancereports_dbcontrolcompliancesummaries, dbframeworkcompliancesummaries

Added 2 behaviors

2026.07.21.3Jul 21, 2026

Added: dbfindingsummaries
Updated: workloads, workloads_updates, workloads_violations

2026.07.21.1Jul 21, 2026

Updated: workloads

2026.07.20.2Jul 20, 2026

Added: dbfindingsummaries
Updated: workloads, workloads_violations

Added 1, modified 1 behaviors

2026.07.20.1Jul 20, 2026

Updated: workloads, workloads_updates, workloads_violations

Removed 1, modified 1 behaviors

2026.07.19.1Jul 19, 2026

Updated: dbfindingsummaries, workloads, workloads_updates, workloads_violations

2026.07.18.2Jul 18, 2026

Updated: dbfindingsummaries, workloads, workloads_updates, workloads_violations

2026.07.17.2Jul 17, 2026

Updated: workloads

2026.07.17.1Jul 17, 2026

Updated: workloads, workloads_violations

2026.06.26.1Jun 26, 2026

Added: dbfindingsummaries

Added 1 behaviors

2026.06.24.1Jun 23, 2026

Updated: workloads, workloads_violations

05Stats

100 / 100

Downloads

Archive size

54.4 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
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#gcp #google-cloud #assuredworkloads #cloud #infrastructure