{"id":15156394,"url":"https://github.com/terraform-ibm-modules/terraform-ibm-data-engine","last_synced_at":"2025-09-30T04:32:26.315Z","repository":{"id":161478629,"uuid":"635723555","full_name":"terraform-ibm-modules/terraform-ibm-data-engine","owner":"terraform-ibm-modules","description":"Module that supports provisioning an IBM Cloud® Data Engine instance","archived":true,"fork":false,"pushed_at":"2024-01-22T11:23:10.000Z","size":333,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":18,"default_branch":"main","last_synced_at":"2024-12-26T15:04:04.438Z","etag":null,"topics":["core-team","data-engine","graduated","ibm-cloud","sql-query","supported","terraform","terraform-module"],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terraform-ibm-modules.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-03T10:16:26.000Z","updated_at":"2024-01-22T13:31:47.000Z","dependencies_parsed_at":"2023-10-27T20:23:00.890Z","dependency_job_id":"5efdeedc-b1e1-4875-9798-d8af136253f5","html_url":"https://github.com/terraform-ibm-modules/terraform-ibm-data-engine","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"terraform-ibm-modules/terraform-ibm-module-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-data-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-data-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-data-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-data-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terraform-ibm-modules","download_url":"https://codeload.github.com/terraform-ibm-modules/terraform-ibm-data-engine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234702075,"owners_count":18873824,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["core-team","data-engine","graduated","ibm-cloud","sql-query","supported","terraform","terraform-module"],"created_at":"2024-09-26T19:20:49.996Z","updated_at":"2025-09-30T04:32:21.034Z","avatar_url":"https://github.com/terraform-ibm-modules.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Data Engine (SQL Query) Module\n\n[![Graduated (Supported)](https://img.shields.io/badge/Status-Graduated%20(Supported)-brightgreen)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)\n[![Build status](https://github.com/terraform-ibm-modules/terraform-ibm-data-engine/actions/workflows/ci.yml/badge.svg)](https://github.com/terraform-ibm-modules/terraform-ibm-data-engine/actions/workflows/ci.yml)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-data-engine?logo=GitHub\u0026sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-data-engine/releases/latest)\n[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n---\n\n:warning: **Deprecated**: IBM Cloud® Data Engine is deprecated. As of 18 February 2024 you can't create new instances, and access to free instances will be removed. Existing Standard plan instances are supported until 18 January 2025. Any instances that still exist on that date will be deleted.\n\n---\n\nThis module provisions an [IBM Cloud® Data Engine](https://cloud.ibm.com/docs/sql-query?topic=sql-query-getting-started) instance.\n\n\u003c!-- Below content is automatically populated via pre-commit hook --\u003e\n\u003c!-- BEGIN OVERVIEW HOOK --\u003e\n## Overview\n* [terraform-ibm-data-engine](#terraform-ibm-data-engine)\n* [Examples](./examples)\n    * [Basic Example](./examples/basic)\n    * [Complete example with BYOK encryption](./examples/complete)\n* [Contributing](#contributing)\n\u003c!-- END OVERVIEW HOOK --\u003e\n\n## terraform-ibm-data-engine\n### Usage\n\n```hcl\nprovider \"ibm\" {\n  ibmcloud_api_key = \"XXXXXXXXXX\"\n  region           = \"us-south\"\n}\n\nmodule \"data_engine\" {\n  source  = \"terraform-ibm-modules/data-engine/ibm\"\n  version = \"latest\" # Replace \"latest\" with a release version to lock into a specific release\n  resource_group_id    = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\n  region               = \"us-south\"\n}\n```\n\n### Required IAM access policies\n\nYou need the following permissions to run this module.\n\n- Account Management\n  - **All Identity and Access Enabled** service\n    - `Viewer` platform access\n  - **All Resource Groups** service\n    - `Viewer` platform access\n- IAM Services\n  - **Data Engine** service\n    - `Editor` platform access\n    - `Manager` service access\n\n\u003c!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n### Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.0.0, \u003c1.6.0 |\n| \u003ca name=\"requirement_ibm\"\u003e\u003c/a\u003e [ibm](#requirement\\_ibm) | \u003e= 1.49.0 |\n| \u003ca name=\"requirement_time\"\u003e\u003c/a\u003e [time](#requirement\\_time) | \u003e= 0.9.1 |\n\n### Modules\n\nNo modules.\n\n### Resources\n\n| Name | Type |\n|------|------|\n| [ibm_iam_authorization_policy.kms_policy](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/iam_authorization_policy) | resource |\n| [ibm_resource_instance.data_engine_instance](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_instance) | resource |\n| [time_sleep.wait_for_authorization_policy](https://registry.terraform.io/providers/hashicorp/time/latest/docs/resources/sleep) | resource |\n\n### Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_existing_kms_instance_guid\"\u003e\u003c/a\u003e [existing\\_kms\\_instance\\_guid](#input\\_existing\\_kms\\_instance\\_guid) | The GUID the Key Protect instance in which the key specified in var.kms\\_key\\_crn is coming from. Required only if var.kms\\_encryption\\_enabled is set to true, var.skip\\_iam\\_authorization\\_policy is set to false. NOTE: Hyper Protect Crypto Services is not currently supported by Data Engine. | `string` | `null` | no |\n| \u003ca name=\"input_instance_name\"\u003e\u003c/a\u003e [instance\\_name](#input\\_instance\\_name) | The name to give the Data Engine instance. | `string` | n/a | yes |\n| \u003ca name=\"input_kms_encryption_enabled\"\u003e\u003c/a\u003e [kms\\_encryption\\_enabled](#input\\_kms\\_encryption\\_enabled) | Set this to true to control the encryption keys used to encrypt the data that you store in Data Engine. If set to false, the data is encrypted by using randomly generated keys. For more info on Key Protect integration, see https://cloud.ibm.com/docs/sql-query?topic=sql-query-securing-data. | `bool` | `false` | no |\n| \u003ca name=\"input_kms_endpoint\"\u003e\u003c/a\u003e [kms\\_endpoint](#input\\_kms\\_endpoint) | The KMS endpoint to use when configuring KMS encryption. Must be private or public. | `string` | `\"private\"` | no |\n| \u003ca name=\"input_kms_key_id\"\u003e\u003c/a\u003e [kms\\_key\\_id](#input\\_kms\\_key\\_id) | The root key ID of a Key Protect key that you want to use to encrypt your stored Data Engine jobs. Only used if var.kms\\_encryption\\_enabled is set to true. NOTE: Hyper Protect Crypto Services is not currently supported by Data Engine. | `string` | `null` | no |\n| \u003ca name=\"input_kms_region\"\u003e\u003c/a\u003e [kms\\_region](#input\\_kms\\_region) | The region where KMS instance exists if using KMS encryption. | `string` | `\"us-south\"` | no |\n| \u003ca name=\"input_plan\"\u003e\u003c/a\u003e [plan](#input\\_plan) | The plan for the Data Engine instance. Supported plans: standard or lite. | `string` | `\"lite\"` | no |\n| \u003ca name=\"input_region\"\u003e\u003c/a\u003e [region](#input\\_region) | The region where you want to deploy your instance. | `string` | `\"us-south\"` | no |\n| \u003ca name=\"input_resource_group_id\"\u003e\u003c/a\u003e [resource\\_group\\_id](#input\\_resource\\_group\\_id) | The resource group ID where the Data Engine instance will be created. | `string` | n/a | yes |\n| \u003ca name=\"input_skip_iam_authorization_policy\"\u003e\u003c/a\u003e [skip\\_iam\\_authorization\\_policy](#input\\_skip\\_iam\\_authorization\\_policy) | Set to true to skip the creation of an IAM authorization policy that permits all Data Engine instances in the resource group to read the encryption key from the KMS instance. If set to false, pass in a value for the KMS instance in the existing\\_kms\\_instance\\_guid variable. In addition, no policy is created if var.kms\\_encryption\\_enabled is set to false. | `bool` | `false` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | (Optional, Array of Strings) A list of tags that you want to add to your instance. | `list(any)` | `[]` | no |\n\n### Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_crn\"\u003e\u003c/a\u003e [crn](#output\\_crn) | data engine crn |\n| \u003ca name=\"output_guid\"\u003e\u003c/a\u003e [guid](#output\\_guid) | data engine guid |\n| \u003ca name=\"output_id\"\u003e\u003c/a\u003e [id](#output\\_id) | data engine id |\n\u003c!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n\u003c!-- BEGIN CONTRIBUTING HOOK --\u003e\n\n\u003c!-- Leave this section as is so that your module has a link to local development environment set up steps for contributors to follow --\u003e\n\n## Contributing\n\nYou can report issues and request features for this module in GitHub issues in the module repo. See [Report an issue or request a feature](https://github.com/terraform-ibm-modules/.github/blob/main/.github/SUPPORT.md).\n\nTo set up your local development environment, see [Local development setup](https://terraform-ibm-modules.github.io/documentation/#/local-dev-setup) in the project documentation.\n\n\u003c!-- Source for this readme file: https://github.com/terraform-ibm-modules/common-dev-assets/tree/main/module-assets/ci/module-template-automation --\u003e\n\u003c!-- END CONTRIBUTING HOOK --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-data-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-data-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-data-engine/lists"}