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

Version latest

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.4.0
• 2.3.0
• 2.2.0

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

Reference documentation and code samples for the Firestore Admin v1 API class Database.Types.EncryptionConfig.Types.CustomerManagedEncryptionOptions.

The configuration options for using CMEK (Customer Managed Encryption Key) encryption.

Inheritance

object > Database.Types.EncryptionConfig.Types.CustomerManagedEncryptionOptions

Implements

IMessageDatabaseTypesEncryptionConfigTypesCustomerManagedEncryptionOptions, IEquatableDatabaseTypesEncryptionConfigTypesCustomerManagedEncryptionOptions, IDeepCloneableDatabaseTypesEncryptionConfigTypesCustomerManagedEncryptionOptions, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

CustomerManagedEncryptionOptions()

public CustomerManagedEncryptionOptions()

CustomerManagedEncryptionOptions(CustomerManagedEncryptionOptions)

public CustomerManagedEncryptionOptions(Database.Types.EncryptionConfig.Types.CustomerManagedEncryptionOptions other)

Parameter
Name	Description
other	DatabaseTypesEncryptionConfigTypesCustomerManagedEncryptionOptions

Properties

KmsKeyName

public string KmsKeyName { get; set; }

Required. Only keys in the same location as the 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