REST Resource: projects.locations.cmekConfigs

リソース: CmekConfig

Cloud KMS 鍵で CMEK データ暗号化を有効にするために使用される構成。

JSON 表現 
{
  "name": string,
  "kmsKey": string,
  "kmsKeyVersion": string,
  "state": enum (State),
  "isDefault": boolean,
  "lastRotationTimestampMicros": string,
  "singleRegionKeys": [
    {
      object (SingleRegionKey)
    }
  ],
  "notebooklmState": enum (NotebookLMState)
}
フィールド
name

string

必須。projects/{project}/locations/{location}/cmekConfig または projects/{project}/locations/{location}/cmekConfigs/{cmekConfig} 形式の CmekConfig の名前。
kmsKey

string

必須。リソース projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} の暗号化に使用される KMS 鍵のリソース名。
kmsKeyVersion

string

出力専用。リソース <kmsKey>/cryptoKeyVersions/{keyVersion} の暗号化に使用される KMS 鍵バージョン リソース名。
state

enum (State)

出力専用。CmekConfig の状態。
isDefault

boolean

出力専用。顧客のデフォルトの CmekConfig。
lastRotationTimestampMicros

string (int64 format)

出力専用。前回の鍵のローテーションのタイムスタンプ。
singleRegionKeys[]

object (SingleRegionKey)

省略可。一部の VAIS 機能に必要な単一リージョン CMEK。
notebooklmState

enum (NotebookLMState)

出力専用。NotebookLM コーパスを使用できる状態かどうか。

状態

CmekConfig の状態。

列挙型
STATE_UNSPECIFIED CmekConfig の状態が不明です。
CREATING CmekConfig を作成しています。
ACTIVE CmekConfig は DataStore で使用できます。
KEY_ISSUE CmekConfig が使用できません。これは、KMS 鍵が取り消されたことが原因である可能性が高いです。
DELETING CmekConfig の削除中です。
DELETE_FAILED CmekConfig の削除プロセスが失敗しました。
UNUSABLE CmekConfig は使用できません。内部的な問題が原因である可能性が高いです。
ACTIVE_ROTATING KMS 鍵バージョンがローテーションされています。
DELETED KMS 鍵が削除済みです。最終的に一部のクリーンアップ ポリシーが適用されます。
EXPIRED KMS 鍵が期限切れです。つまり、鍵が 30 日以上無効になっています。お客様は cmekConfigs.delete を呼び出して、状態を DELETED に変更できます。

SingleRegionKey

単一リージョン CMEK のメタデータ。

JSON 表現 
{
  "kmsKey": string
}
フィールド
kmsKey

string

必須。リソース projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} の暗号化に使用される単一リージョンの KMS 鍵リソース名。

NotebookLMState

NotebookLM の状態。

列挙型
NOTEBOOK_LM_STATE_UNSPECIFIED NotebookLM の状態が不明です。
NOTEBOOK_LM_NOT_READY NotebookLM の準備ができていません。
NOTEBOOK_LM_READY NotebookLM を使用できるようになりました。
NOTEBOOK_LM_NOT_ENABLED NotebookLM が有効になっていない。

メソッド

delete

 CmekConfig のプロビジョニングを解除します。

get

 CmekConfig を取得します。

list

 プロジェクトのすべての CmekConfig を一覧表示します。

patch

 顧客のプロジェクトのロケーションで使用する CMEK 鍵をプロビジョニングします。