REST Resource: projects.locations.cmekConfigs

Resource: CmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys.

JSON representation
{
  "name": string,
  "kmsKey": string,
  "kmsKeyVersion": string,
  "state": enum (State),
  "isDefault": boolean,
  "lastRotationTimestampMicros": string,
  "singleRegionKeys": [
    {
      object (SingleRegionKey)
    }
  ],
  "notebooklmState": enum (NotebookLMState)
}
Fields
name

string

Required. The name of the CmekConfig of the form projects/{project}/locations/{location}/cmekConfig or projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}.

kmsKey

string

KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

kmsKeyVersion

string

KMS key version resource name which will be used to encrypt resources <kmsKey>/cryptoKeyVersions/{keyVersion}.

state

enum (State)

Output only. The states of the CmekConfig.

isDefault

boolean

Output only. The default CmekConfig for the Customer.

lastRotationTimestampMicros

string (int64 format)

Output only. The timestamp of the last key rotation.

singleRegionKeys[]

object (SingleRegionKey)

Optional. Single-regional CMEKs that are required for some VAIS features.

notebooklmState

enum (NotebookLMState)

Output only. Whether the NotebookLM Corpus is ready to be used.

State

States of the CmekConfig.

Enums
STATE_UNSPECIFIEDThe CmekConfig state is unknown.
CREATINGThe CmekConfig is creating.
ACTIVEThe CmekConfig can be used with DataStores.
KEY_ISSUEThe CmekConfig is unavailable, most likely due to the KMS Key being revoked.
DELETINGThe CmekConfig is deleting.
DELETE_FAILEDThe CmekConfig deletion process failed.
UNUSABLEThe CmekConfig is not usable, most likely due to some internal issue.
ACTIVE_ROTATINGThe KMS key version is being rotated.

SingleRegionKey

Metadata for single-regional CMEKs.

JSON representation
{
  "kmsKey": string
}
Fields
kmsKey

string

Required. Single-regional kms key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

NotebookLMState

States of NotebookLM.

Enums
NOTEBOOK_LM_STATE_UNSPECIFIEDThe NotebookLM state is unknown.
NOTEBOOK_LM_NOT_READYThe NotebookLM is not ready.
NOTEBOOK_LM_READYThe NotebookLM is ready to be used.
NOTEBOOK_LM_NOT_ENABLEDThe NotebookLM is not enabled.

Methods

delete

De-provisions a CmekConfig.

get

Gets the CmekConfig.

list

Lists all the CmekConfigs with the project.

Provisions a CMEK key for use in a location of a customer's project.