# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Database::CmekConfig (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 0.16.0 0.15.0 0.14.3 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.5 Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Database::CmekConfig.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #active_key_version

    def active_key_version() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Output only. Currently in-use [KMS key
  versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/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}`.

### #kms_key_name

    def kms_key_name() -> ::String

**Returns**

- (::String) --- 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}`.

### #kms_key_name=

    def kms_key_name=(value) -> ::String

**Parameter**

- **value** (::String) --- 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}`.
**Returns**

- (::String) --- 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}`.