Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryptionConfig} Global location is not supported.
key
string
Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.
Output only. The time when the Encryption configuration was created.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
Output only. The time when the Encryption configuration was last updated.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
Output only. Details of the failure if anything related to Cmek db fails.
EncryptionState
State of encryption of the databases when EncryptionConfig is created or updated.
Enums
ENCRYPTION_STATE_UNSPECIFIED
State is not specified.
ENCRYPTING
The encryption state of the database when the EncryptionConfig is created or updated. If the encryption fails, it is retried indefinitely and the state is shown as ENCRYPTING.
COMPLETED
The encryption of data has completed successfully.
FAILED
The encryption of data has failed. The state is set to FAILED when the encryption fails due to reasons like permission issues, invalid key etc.
FailureDetails
Details of the failure if anything related to Cmek db fails.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-08 UTC."],[],[],null,["- [Resource: EncryptionConfig](#EncryptionConfig)\n - [JSON representation](#EncryptionConfig.SCHEMA_REPRESENTATION)\n- [EncryptionState](#EncryptionState)\n- [FailureDetails](#FailureDetails)\n - [JSON representation](#FailureDetails.SCHEMA_REPRESENTATION)\n- [ErrorCode](#ErrorCode)\n- [Methods](#METHODS_SUMMARY)\n\nResource: EncryptionConfig A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"key\": string, \"createTime\": string, \"updateTime\": string, \"encryptionState\": enum (/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#EncryptionState), \"etag\": string, \"failureDetails\": { object (/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#FailureDetails) } } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryptionConfig} Global location is not supported. |\n| `key` | `string` Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time when the Encryption configuration was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time when the Encryption configuration was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `encryptionState` | `enum (`[EncryptionState](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#EncryptionState)`)` Output only. The state of encryption of the databases. |\n| `etag` | `string` Etag of the EncryptionConfig. This is a strong etag. |\n| `failureDetails` | `object (`[FailureDetails](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#FailureDetails)`)` Output only. Details of the failure if anything related to Cmek db fails. |\n\nEncryptionState State of encryption of the databases when EncryptionConfig is created or updated.\n\n| Enums ||\n|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ENCRYPTION_STATE_UNSPECIFIED` | State is not specified. |\n| `ENCRYPTING` | The encryption state of the database when the EncryptionConfig is created or updated. If the encryption fails, it is retried indefinitely and the state is shown as ENCRYPTING. |\n| `COMPLETED` | The encryption of data has completed successfully. |\n| `FAILED` | The encryption of data has failed. The state is set to FAILED when the encryption fails due to reasons like permission issues, invalid key etc. |\n\nFailureDetails Details of the failure if anything related to Cmek db fails.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"errorCode\": enum (/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#ErrorCode), \"errorMessage\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `errorCode` | `enum (`[ErrorCode](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs#ErrorCode)`)` Output only. The error code for the failure. |\n| `errorMessage` | `string` Output only. The error message will be shown to the user. Set only if the error code is REQUIRE_USER_ACTION. |\n\nErrorCode Error code for the failure if anything related to Cmek db fails.\n\n| Enums ||\n|-----------------------|------------------------------------------------------------------------|\n| `UNKNOWN` | The error code is not specified |\n| `INTERNAL_ERROR` | Error because of internal server error, will be retried automatically. |\n| `REQUIRE_USER_ACTION` | User action is required to resolve the error. |\n\n| Methods ||\n|---------------------------------------------------------------------------------------------|-----------------------------|\n| [create](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/create) | Create an EncryptionConfig. |\n| [delete](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/delete) | Delete an EncryptionConfig. |\n| [get](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/get) | Get an EncryptionConfig. |\n| [list](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/list) | List EncryptionConfigs. |\n| [patch](/dataplex/docs/reference/rest/v1/organizations.locations.encryptionConfigs/patch) | Update an EncryptionConfig. |"]]
