View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1CmekConfig (google_api_firestore v0.27.0)

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key.

Attributes

  • activeKeyVersion (type: list(String.t), default: nil) - Output only. Currently in-use KMS key versions. During key rotation, there can be multiple in-use key versions. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.
  • kmsKeyName (type: String.t, default: nil) - Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

View Source 
@type t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1CmekConfig{
  activeKeyVersion: [String.t()] | nil,
  kmsKeyName: String.t() | nil
}

Functions

Link to this function

decode(value, options)

View Source 
@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.