- Resource: Workload
- ResourceConfig
- NewProjectConfig
- NewFolderConfig
- FrameworkReference
- CloudControlConfig
- Parameter
- ParamValue
- StringList
- EnforcementMode
- State
- KajEnrollmentType
- Methods
Resource: Workload
A Workload resource for managing data boundary and compliance controls on a Google Cloud resource.
| JSON representation |
|---|
{ "name": string, "resourceConfig": { object ( |
| Fields | |
|---|---|
name |
Identifier. The resource name of the workload. Format: |
resourceConfig |
Required. Target Google Cloud folder or project where controls are deployed. |
computedTargetResource |
Output only. The resolved target resource name, in the format |
framework |
Required. The compliance framework active on this workload. |
description |
Optional. The user-provided description for the workload. |
cloudControlConfigs[] |
Required. The cloud control configurations enforced on this workload. |
state |
Output only. The current lifecycle state of the workload. |
createTime |
Output only. The timestamp when the workload was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. The timestamp when the workload was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
etag |
Optional. An opaque concurrency control token calculated by the server based on the current state of the workload. It may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
targetResourceDisplayName |
Output only. The user-facing display name of the target resource. |
kajEnrollmentType |
Optional. The customer's Key Access Transparency (KAT) choice for this workload. When unspecified, the service applies the default enablement rules: KAT is enabled for eligible frameworks deployed in preventive mode. |
ResourceConfig
Target resource configuration for the workload.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "existingProject": string, "existingFolder": string, "newProjectConfig": { object ( |
| Fields | |
|---|---|
| Target resource selection. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
existingProject |
Optional. Reference to an existing Google Cloud project. Format: |
existingFolder |
Optional. Reference to an existing Google Cloud folder. Format: |
newProjectConfig |
Optional. Configuration to provision a new Google Cloud project. |
newFolderConfig |
Optional. Configuration to provision a new Google Cloud folder. |
| End of mutually exclusive fields. | |
NewProjectConfig
Configuration for provisioning a new Google Cloud project.
| JSON representation |
|---|
{ "parent": string, "displayName": string, "billingAccount": string } |
| Fields | |
|---|---|
parent |
Required. The parent resource where the project is created. Format: |
displayName |
Required. The user-friendly display name for the new project. |
billingAccount |
Required. The billing account to link to the new project. Format: |
NewFolderConfig
Configuration for provisioning a new Google Cloud folder.
| JSON representation |
|---|
{ "parent": string, "displayName": string } |
| Fields | |
|---|---|
parent |
Required. The parent resource where the folder is created. Format: |
displayName |
Required. The user-friendly display name for the new folder. |
FrameworkReference
Reference to a compliance framework.
| JSON representation |
|---|
{ "framework": string, "majorRevisionId": string } |
| Fields | |
|---|---|
framework |
Required. The name of the framework. |
majorRevisionId |
Optional. The major version of the framework. |
CloudControlConfig
Cloud control configuration applied to the workload.
| JSON representation |
|---|
{ "cloudControl": string, "cloudControlRevision": integer, "parameters": [ { object ( |
| Fields | |
|---|---|
cloudControl |
Required. The name of the cloud control, in the format |
cloudControlRevision |
Required. The revision of the cloud control. |
parameters[] |
Optional. Parameters for the cloud control configuration. |
enforcementMode |
Required. The enforcement mode for the cloud control. |
Parameter
Parameters are key-value pairs that let you provide custom settings.
| JSON representation |
|---|
{
"name": string,
"parameterValue": {
object ( |
| Fields | |
|---|---|
name |
Required. The name or key of the parameter. |
parameterValue |
Required. The value of the parameter. |
ParamValue
The possible parameter value types.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringValue": string, "boolValue": boolean, "stringListValue": { object ( |
| Fields | |
|---|---|
| The list of possible parameter value types. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
stringValue |
A string value. |
boolValue |
A boolean value. |
stringListValue |
A repeated string. |
numberValue |
A double value. |
oneofValue |
Sub-parameter values. |
| End of mutually exclusive fields. | |
StringList
A list of strings for the parameter value.
| JSON representation |
|---|
{ "values": [ string ] } |
| Fields | |
|---|---|
values[] |
Required. The strings in the list. |
EnforcementMode
The enforcement mode for the cloud control.
| Enums | |
|---|---|
ENFORCEMENT_MODE_UNSPECIFIED |
Default value. This value is unused. |
PREVENTIVE |
The cloud control is enforced to prevent non-compliance. |
DETECTIVE |
The cloud control is enforced to detect non-compliance. |
AUDIT |
The cloud control is enforced to audit for non-compliance. |
State
Represents the lifecycle state of the workload.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
CREATING |
The workload is being created. |
ACTIVE |
The workload is active and compliance controls are enforced. |
UPDATING |
The workload is being updated. |
DELETING |
The workload is being deleted. |
FAILED |
The workload deployment failed. |
PARTIALLY_ACTIVE |
The workload is partially active because some resources or controls failed to provision. |
PARTIALLY_DELETED |
The workload is partially deleted because some resources or controls failed to be removed. |
PARTIALLY_UPDATED |
The workload is partially updated because some control updates failed to apply. |
KajEnrollmentType
The customer's Key Access Transparency (KAT) choice for a workload. This enum is not frozen; values may be added in the future.
| Enums | |
|---|---|
KAJ_ENROLLMENT_TYPE_UNSPECIFIED |
Default unspecified type. The service applies the default enablement rules: KAT is enabled for eligible frameworks deployed in preventive mode. |
KEY_ACCESS_TRANSPARENCY_ENABLED |
KAT is enabled for the workload. |
KEY_ACCESS_TRANSPARENCY_DISABLED |
KAT is disabled for the workload. |
Methods |
|
|---|---|
|
Creates a new Assured Workload. |
|
Deletes an Assured Workload. |
|
Gets the details for a specific Assured Workload. |
|
Lists Assured Workloads in a given organization and location. |
|
Updates an existing Assured Workload. |