01README
Google Cloud assuredworkloads infrastructure models
02Models
@swamp/gcp/assuredworkloads/workloadsv2026.04.23.1workloads.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| billingAccount? | string | 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 | Required. Immutable. Compliance Regime associated with this workload. |
| complianceStatus? | object | Represents the Compliance Status of this workload |
| displayName? | string | 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 |
| ekmProvisioningResponse? | object | External key management systems(EKM) Provisioning response |
| enableSovereignControls? | boolean | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| labels? | record | Optional. Labels applied to the workload. |
| name? | string | Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| partner? | enum | Optional. Partner regime associated with this workload. |
| partnerPermissions? | object | Permissions granted to the AW Partner SA account for the customer workload |
| partnerServicesBillingAccount? | string | 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 | 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 | 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. |
| saaEnrollmentResponse? | object | Signed Access Approvals (SAA) enrollment response. |
| violationNotificationsEnabled? | boolean | 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 | Options to be set for the given created workload. |
| externalId? | string | 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 | 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 | Description |
|---|---|---|
| identifier | string | The name of the workloads |
fn update()
Update workloads attributes
fn delete(identifier: string)
Delete the workloads
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workloads |
fn sync()
Sync workloads state from GCP
fn analyze_workload_move()
analyze workload move
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 | Description |
|---|---|---|
| etag? | any | |
| partnerPermissions? | any | |
| updateMask? | any |
fn restrict_allowed_resources(restrictionType?: any)
restrict allowed resources
| Argument | Type | Description |
|---|---|---|
| restrictionType? | any |
Resources
state(infinite)— A Workload object for managing highly regulated workloads of cloud customers.
@swamp/gcp/assuredworkloads/workloads-updatesv2026.04.23.1workloads_updates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the updates |
fn sync()
Sync updates state from GCP
fn apply(action?: any)
apply
| Argument | Type | Description |
|---|---|---|
| action? | any |
Resources
state(infinite)— A workload update is a change to the workload's compliance configuration.
@swamp/gcp/assuredworkloads/workloads-violationsv2026.04.23.1workloads_violations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | 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 | Description |
|---|---|---|
| identifier | string | The name of the violations |
fn sync()
Sync violations state from GCP
fn acknowledge(acknowledgeType?: any, comment?: any, nonCompliantOrgPolicy?: any)
acknowledge
| Argument | Type | Description |
|---|---|---|
| acknowledgeType? | any | |
| comment? | any | |
| nonCompliantOrgPolicy? | any |
Resources
state(infinite)— Workload monitoring Violation.
03Previous Versions
2026.04.04.1Apr 4, 2026
- Updated: workloads_updates
2026.04.03.3Apr 3, 2026
- Updated: workloads, workloads_updates, workloads_violations
2026.04.03.1Apr 3, 2026
- Updated: workloads, workloads_updates, workloads_violations
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: workloads, workloads_updates, workloads_violations
04Stats
A
100 / 100
Downloads
0
Archive size
25.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 types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels