bigframes._config.BigQueryOptions.kms_key_name#

propertyBigQueryOptions.kms_key_name:str|None#

Customer managed encryption key used to control encryption of thedata-at-rest in BigQuery. This is of the formatprojects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY.

For more information, seehttps://cloud.google.com/bigquery/docs/customer-managed-encryptionCustomer-managed Cloud KMS keys

Make sure the project used for Bigquery DataFrames has theCloud KMS CryptoKey Encrypter/Decrypter IAM role in the key’s project.For more information, seehttps://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_roleAssign the Encrypter/Decrypter.

Returns:

Name of the customer managed encryption key as a string; otherwise None.

Return type:

None orstr