Resource: KmsConfig
KmsConfig is the customer managed encryption key(CMEK) configuration.
JSON representation |
---|
{
"name": string,
"cryptoKeyName": string,
"state": enum ( |
Fields | |
---|---|
name |
Identifier. Name of the KmsConfig. |
crypto |
Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. |
state |
Output only. State of the KmsConfig. |
state |
Output only. State details of the KmsConfig. |
create |
Output only. Create time of the KmsConfig. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
description |
Description of the KmsConfig. |
labels |
Labels as key value pairs An object containing a list of |
instructions |
Output only. Instructions to provide the access to the customer provided encryption key. |
service |
Output only. The Service account which will have access to the customer provided encryption key. |
State
The KmsConfig States
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified KmsConfig State |
READY |
KmsConfig State is Ready |
CREATING |
KmsConfig State is Creating |
DELETING |
KmsConfig State is Deleting |
UPDATING |
KmsConfig State is Updating |
IN_USE |
KmsConfig State is In Use. |
ERROR |
KmsConfig State is Error |
KEY_CHECK_PENDING |
KmsConfig State is Pending to verify crypto key access. |
KEY_NOT_REACHABLE |
KmsConfig State is Not accessbile by the SDE service account to the crypto key. |
DISABLING |
KmsConfig State is Disabling. |
DISABLED |
KmsConfig State is Disabled. |
MIGRATING |
KmsConfig State is Migrating. The existing volumes are migrating from SMEK to CMEK. |
Methods |
|
---|---|
|
Creates a new KMS config. |
|
Warning! |
|
Encrypt the existing volumes without CMEK encryption with the desired the KMS config for the whole region. |
|
Returns the description of the specified KMS config by kms_config_id. |
|
Returns descriptions of all KMS configs owned by the caller. |
|
Updates the Kms config properties with the full spec |
|
Verifies KMS config reachability. |