Firestore Admin v1 API - Class Database.Types.CmekConfig (3.11.0) 

public sealed class Database.Types.CmekConfig : IMessage<Database.Types.CmekConfig>, IEquatable<Database.Types.CmekConfig>, IDeepCloneable<Database.Types.CmekConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class Database.Types.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.

Inheritance

object > Database.Types.CmekConfig

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

CmekConfig()

public CmekConfig()

CmekConfig(CmekConfig)

public CmekConfig(Database.Types.CmekConfig other)
Parameter
Name Description
other DatabaseTypesCmekConfig

Properties

ActiveKeyVersion

public RepeatedField<string> ActiveKeyVersion { get; }

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}.

Property Value
Type Description
RepeatedFieldstring

KmsKeyName

public string KmsKeyName { get; set; }

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}.

Property Value
Type Description
string