- Resource: Workload
- IL4Settings
- KMSSettings
- CJISSettings
- FedrampHighSettings
- FedrampModerateSettings
- ResourceInfo
- ResourceType
- ComplianceRegime
- ResourceSettings
- KajEnrollmentState
- SaaEnrollmentResponse
- SetupState
- SetupError
- ComplianceStatus
- Partner
- Methods
Resource: Workload
A Workload object for managing highly regulated workloads of cloud customers.
JSON representation |
---|
{ "name": string, "displayName": string, "resources": [ { object ( |
Fields | |
---|---|
name |
Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
displayName |
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 |
resources[] |
Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. |
complianceRegime |
Required. Immutable. Compliance Regime associated with this workload. |
createTime |
Output only. Immutable. The Workload creation timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
billingAccount |
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 |
etag |
Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
labels |
Optional. Labels applied to the workload. An object containing a list of |
provisionedResourcesParent |
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} |
kmsSettings |
Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. |
resourceSettings[] |
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. |
kajEnrollmentState |
Output only. Represents the KAJ enrollment state of the given workload. |
enableSovereignControls |
Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
saaEnrollmentResponse |
Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during workloads.get call. In failure cases, user friendly error message is shown in SAA details page. |
complianceStatus |
Output only. Count of active Violations in the Workload. |
compliantButDisallowedServices[] |
Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke workloads.restrictAllowedResources endpoint to allow your project developers to use these services in their environment." |
partner |
Optional. Compliance Regime associated with this workload. |
Union field compliance_regime_settings . Settings specific to the selected [compliance_regime] compliance_regime_settings can be only one of the following: |
|
il4Settings |
Input only. Immutable. Settings specific to resources needed for IL4. |
cjisSettings |
Input only. Immutable. Settings specific to resources needed for CJIS. |
fedrampHighSettings |
Input only. Immutable. Settings specific to resources needed for FedRAMP High. |
fedrampModerateSettings |
Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate. |
IL4Settings
Settings specific to resources needed for IL4.
JSON representation |
---|
{
"kmsSettings": {
object ( |
Fields | |
---|---|
kmsSettings |
Input only. Immutable. Settings used to create a CMEK crypto key. |
KMSSettings
Settings specific to the Key Management Service.
JSON representation |
---|
{ "nextRotationTime": string, "rotationPeriod": string } |
Fields | |
---|---|
nextRotationTime |
Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
rotationPeriod |
Required. Input only. Immutable. [nextRotationTime] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. A duration in seconds with up to nine fractional digits, ending with ' |
CJISSettings
Settings specific to resources needed for CJIS.
JSON representation |
---|
{
"kmsSettings": {
object ( |
Fields | |
---|---|
kmsSettings |
Input only. Immutable. Settings used to create a CMEK crypto key. |
FedrampHighSettings
Settings specific to resources needed for FedRAMP High.
JSON representation |
---|
{
"kmsSettings": {
object ( |
Fields | |
---|---|
kmsSettings |
Input only. Immutable. Settings used to create a CMEK crypto key. |
FedrampModerateSettings
Settings specific to resources needed for FedRAMP Moderate.
JSON representation |
---|
{
"kmsSettings": {
object ( |
Fields | |
---|---|
kmsSettings |
Input only. Immutable. Settings used to create a CMEK crypto key. |
ResourceInfo
Represent the resources that are children of this Workload.
JSON representation |
---|
{
"resourceId": string,
"resourceType": enum ( |
Fields | |
---|---|
resourceId |
Resource identifier. For a project this represents project_number. |
resourceType |
Indicates the type of resource. |
ResourceType
The type of resource.
Enums | |
---|---|
RESOURCE_TYPE_UNSPECIFIED |
Unknown resource type. |
CONSUMER_PROJECT |
Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value. |
CONSUMER_FOLDER |
Consumer Folder. |
ENCRYPTION_KEYS_PROJECT |
Consumer project containing encryption keys. |
KEYRING |
Keyring resource that hosts encryption keys. |
ComplianceRegime
Supported Compliance Regimes.
Enums | |
---|---|
COMPLIANCE_REGIME_UNSPECIFIED |
Unknown compliance regime. |
IL4 |
Information protection as per DoD IL4 requirements. |
CJIS |
Criminal Justice Information Services (CJIS) Security policies. |
FEDRAMP_HIGH |
FedRAMP High data protection controls |
FEDRAMP_MODERATE |
FedRAMP Moderate data protection controls |
US_REGIONAL_ACCESS |
Assured Workloads For US Regions data protection controls |
HIPAA |
Health Insurance Portability and Accountability Act controls |
HITRUST |
Health Information Trust Alliance controls |
EU_REGIONS_AND_SUPPORT |
Assured Workloads For EU Regions and Support controls |
CA_REGIONS_AND_SUPPORT |
Assured Workloads For Canada Regions and Support controls |
ITAR |
International Traffic in Arms Regulations |
AU_REGIONS_AND_US_SUPPORT |
Assured Workloads for Australia Regions and Support controls Available for public preview consumption. Don't create production workloads. |
ASSURED_WORKLOADS_FOR_PARTNERS |
Assured Workloads for Partners; |
ResourceSettings
Represent the custom settings for the resources to be created.
JSON representation |
---|
{
"resourceId": string,
"resourceType": enum ( |
Fields | |
---|---|
resourceId |
Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google. |
resourceType |
Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
displayName |
User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
KajEnrollmentState
Key Access Justifications(KAJ) Enrollment State.
Enums | |
---|---|
KAJ_ENROLLMENT_STATE_UNSPECIFIED |
Default State for KAJ Enrollment. |
KAJ_ENROLLMENT_STATE_PENDING |
Pending State for KAJ Enrollment. |
KAJ_ENROLLMENT_STATE_COMPLETE |
Complete State for KAJ Enrollment. |
SaaEnrollmentResponse
Signed Access Approvals (SAA) enrollment response.
JSON representation |
---|
{ "setupErrors": [ enum ( |
Fields | |
---|---|
setupErrors[] |
Indicates SAA enrollment setup error if any. |
setupStatus |
Indicates SAA enrollment status of a given workload. |
SetupState
Setup state of SAA enrollment.
Enums | |
---|---|
SETUP_STATE_UNSPECIFIED |
Unspecified. |
STATUS_PENDING |
SAA enrollment pending. |
STATUS_COMPLETE |
SAA enrollment comopleted. |
SetupError
Setup error of SAA enrollment.
Enums | |
---|---|
SETUP_ERROR_UNSPECIFIED |
Unspecified. |
ERROR_INVALID_BASE_SETUP |
Invalid states for all customers, to be redirected to AA UI for additional details. |
ERROR_MISSING_EXTERNAL_SIGNING_KEY |
Returned when there is not an EKM key configured. |
ERROR_NOT_ALL_SERVICES_ENROLLED |
Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services. |
ERROR_SETUP_CHECK_FAILED |
Returned when exception was encountered during evaluation of other criteria. |
ComplianceStatus
Represents the Compliance Status of this workload
JSON representation |
---|
{ "activeViolationCount": integer, "acknowledgedViolationCount": integer } |
Fields | |
---|---|
activeViolationCount |
Count of active Violations which haven't been acknowledged. |
acknowledgedViolationCount |
Count of active Violations which are acknowledged in the Workload. |
Partner
Supported Assured Workloads Partners.
Enums | |
---|---|
PARTNER_UNSPECIFIED |
Unknown partner regime/controls. |
LOCAL_CONTROLS_BY_S3NS |
S3NS regime/controls. |
SOVEREIGN_CONTROLS_BY_T_SYSTEMS |
TSystems regime/controls. |
Methods |
|
---|---|
|
Creates Assured Workload. |
|
Deletes the workload. |
|
Gets Assured Workload associated with a CRM Node |
|
Lists Assured Workloads under a CRM Node. |
|
Updates an existing workload. |
|
Restrict the list of resources allowed in the Workload environment. |