REST Resource: projects.locations.keyRings.cryptoKeys

リソース: CryptoKey

CryptoKey は、暗号オペレーションに使用できる論理鍵を表したものです。

CryptoKey は、暗号オペレーションで使用される実際の鍵マテリアルを表す 0 個以上の versions で構成されます。

JSON 表現 
{
  "name": string,
  "primary": {
    object (CryptoKeyVersion)
  },
  "purpose": enum (CryptoKeyPurpose),
  "createTime": string,
  "nextRotationTime": string,
  "versionTemplate": {
    object (CryptoKeyVersionTemplate)
  },
  "labels": {
    string: string,
    ...
  },
  "importOnly": boolean,
  "destroyScheduledDuration": string,
  "cryptoKeyBackend": string,

  // Union field rotation_schedule can be only one of the following:
  "rotationPeriod": string
  // End of list of possible types for union field rotation_schedule.
}
フィールド
name

string

出力専用。この CryptoKey のリソース名（projects/*/locations/*/keyRings/*/cryptoKeys/* 形式）。
primary

object (CryptoKeyVersion)

出力専用。この CryptoKey が [EncryptRequest.name][] で指定されている場合に [Encrypt][KeyManagementService.Encrypt] で使用される「プライマリ」CryptoKeyVersion のコピー。

CryptoKey のプライマリ バージョンは、[UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] によって更新できます。

purpose ENCRYPT_DECRYPT の鍵にはプライマリが存在する場合があります。他の鍵の場合、このフィールドは省略されます。
purpose

enum (CryptoKeyPurpose)

変更不可。この CryptoKey の不変の目的。
createTime

string (Timestamp format)

出力専用。この CryptoKey が作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
nextRotationTime

string (Timestamp format)

nextRotationTime に、Key Management Service によって自動的に次のことが行われます。

  1. この CryptoKey の新しいバージョンを作成します。
  2. 新しいバージョンをメインとしてマークします。

[CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] と [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] で手動で行う鍵のローテーションは、nextRotationTime には影響しません。

purpose ENCRYPT_DECRYPT を持つ鍵は自動ローテーションをサポートしています。他の鍵については、このフィールドを省略する必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
versionTemplate

object (CryptoKeyVersionTemplate)

新しい CryptoKeyVersion インスタンスの設定を記述するテンプレート。[CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] または自動ローテーションによって作成された新しい CryptoKeyVersion インスタンスのプロパティは、このテンプレートによって制御されます。
labels

map (key: string, value: string)

ユーザー定義のメタデータを持つラベル。 詳細については、鍵のラベル付けをご覧ください。
importOnly

boolean

変更不可。この鍵にインポート済みのバージョンのみを含めるかどうか。
destroyScheduledDuration

string (Duration format)

変更不可。この鍵のバージョンが DESTROYED に移行する前に DESTROY_SCHEDULED 状態だった期間。作成時に指定しない場合、デフォルトの期間は 24 時間です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
cryptoKeyBackend

string

変更不可。この CryptoKey に関連付けられたすべての CryptoKeyVersions の鍵マテリアルが存在し、関連するすべての暗号オペレーションが実行されるバックエンド環境のリソース名。CryptoKeyVersions に [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] の ProtectionLevel があり、リソース名が projects/*/locations/*/ekmConnections/* の形式の場合にのみ適用されます。このリストはすべてを網羅したものではなく、今後追加の ProtectionLevels が適用される場合があることに留意してください。
共用体フィールド rotation_schedule。自動ローテーションのレートを制御します。rotation_schedule は次のいずれかになります。
rotationPeriod

string (Duration format)

サービスが自動的に鍵のローテーションを行う場合、nextRotationTime はこの期間だけ進められます。24 時間以上 876,000 時間以下にする必要があります。

rotationPeriod が設定されている場合は、nextRotationTime も設定する必要があります。

purpose ENCRYPT_DECRYPT を持つ鍵は自動ローテーションをサポートしています。他の鍵については、このフィールドを省略する必要があります。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

メソッド

getProtectedResourcesSummary

 指定された Cloud KMS CryptoKey で保護されたリソースの集計情報を返します。