Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

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

Instance Attribute Summary

• #active_key_version ⇒ Array<String>

  Output only.

• #kms_key_name ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirestoreAdminV1CmekConfig constructor

  A new instance of GoogleFirestoreAdminV1CmekConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1CmekConfig

Returns a new instance of GoogleFirestoreAdminV1CmekConfig.

# File 'lib/google/apis/firestore_v1/classes.rb', line 1423

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_key_version ⇒ Array<String>

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`. Corresponds to the JSON propertyactiveKeyVersion`

Returns:

• (Array<String>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 1411

def active_key_version
  @active_key_version
end

#kms_key_name ⇒ 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`. Corresponds to the JSON propertykmsKeyName`

Returns:

• (String)

# File 'lib/google/apis/firestore_v1/classes.rb', line 1421

def kms_key_name
  @kms_key_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 1428

def update!(**args)
  @active_key_version = args[:active_key_version] if args.key?(:active_key_version)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
end