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
}
Fields
name

string

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

State

States of the CmekConfig.

Enums
STATE_UNSPECIFIED The CmekConfig state is unknown.
CREATING The CmekConfig is creating.
ACTIVE The CmekConfig can be used with DataStores.
KEY_ISSUE The CmekConfig is unavailable, most likely due to the KMS Key being revoked.
DELETING The CmekConfig is deleting.
UNUSABLE The CmekConfig is not usable, most likely due to some internal issue.
ACTIVE_ROTATING The KMS key version is being rotated.

Methods

get

 Gets the CmekConfig.

list

 Lists all the CmekConfigs with the project.

patch

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