REST Resource: organizations.workloads

Resource: Workload

An Workload object for managing highly regulated workloads of cloud customers.

JSON representation
{
  "name": string,
  "displayName": string,
  "projectNumbers": [
    string
  ],
  "complianceRegime": enum (ComplianceRegime),
  "createTime": string,
  "region": string,
  "billingAccount": string,

  // Union field compliance_regime_settings can be only one of the following:
  "il4Settings": {
    object (IL4Settings)
  },
  "cjisSettings": {
    object (CJISSettings)
  }
  // End of list of possible types for union field compliance_regime_settings.
}
Fields
name

string

Output only. The resource name of the workload. Format: organizations/{organization}/workloads/{workload}

Read-only.

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

Read-only after creation.

projectNumbers[]

string (int64 format)

Output only. The project numbers associated with this workload. These project numbers will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.

complianceRegime

enum (ComplianceRegime)

Required. Immutable. Compliance Regime associated with this workload.

createTime

string (Timestamp format)

Output only. Immutable. The Workload creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

region

string

Required. Immutable. Region for workload resources. Currently, only US regions are supported.

Read-only after creation.

billingAccount

string

Required. Input only. Immutable. The resource name of the billing account used for the project that holds the crypto key. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF.

Union field compliance_regime_settings. Settings specific to the selected [compliance_regime] compliance_regime_settings can be only one of the following:
il4Settings

object (IL4Settings)

Required. Input only. Immutable. Settings specific to resources needed for IL4.

cjisSettings

object (CJISSettings)

Required. Input only. Immutable. Settings specific to resources needed for CJIS.

ComplianceRegime

Supported Compliance Regimes.

Enums
COMPLIANCE_REGIME_UNSPECIFIED Unknown compliance regime.
COMPLIANCE_REGIME_IL4 Information protection as per DoD IL4 requirements.
COMPLIANCE_REGIME_CJIS Criminal Justice Information Services (CJIS) Security policies.

IL4Settings

Settings specific to resources needed for IL4.

JSON representation
{
  "kmsSettings": {
    object (KMSSettings)
  }
}
Fields
kmsSettings

object (KMSSettings)

Required. 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

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

rotationPeriod

string (Duration format)

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, terminated by 's'. Example: "3.5s".

CJISSettings

Settings specific to resources needed for CJIS.

JSON representation
{
  "kmsSettings": {
    object (KMSSettings)
  }
}
Fields
kmsSettings

object (KMSSettings)

Required. Input only. Immutable. Settings used to create a CMEK crypto key.

Methods

create

Creates Assured Workload against a CRM Node

get

Gets Assured Workload associated with a CRM Node

list

Lists Assured Workloads under a CRM Node.