{"id":22689041,"url":"https://github.com/terraform-ibm-modules/terraform-ibm-cloudant","last_synced_at":"2026-05-30T02:02:25.054Z","repository":{"id":43845254,"uuid":"372818380","full_name":"terraform-ibm-modules/terraform-ibm-cloudant","owner":"terraform-ibm-modules","description":"Deploys and configures an IBM Cloudant instance","archived":false,"fork":false,"pushed_at":"2026-05-26T08:27:36.000Z","size":938,"stargazers_count":0,"open_issues_count":3,"forks_count":3,"subscribers_count":13,"default_branch":"main","last_synced_at":"2026-05-26T10:23:52.202Z","etag":null,"topics":["cloudant","core-team","deployable-architecture","graduated","supported","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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-06-01T12:15:49.000Z","updated_at":"2026-05-26T10:12:19.000Z","dependencies_parsed_at":"2025-12-28T23:05:42.842Z","dependency_job_id":null,"html_url":"https://github.com/terraform-ibm-modules/terraform-ibm-cloudant","commit_stats":null,"previous_names":[],"tags_count":87,"template":false,"template_full_name":null,"purl":"pkg:github/terraform-ibm-modules/terraform-ibm-cloudant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-cloudant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-cloudant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-cloudant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-cloudant/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-cloudant/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-ibm-modules%2Fterraform-ibm-cloudant/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33677261,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cloudant","core-team","deployable-architecture","graduated","supported","terraform-module"],"created_at":"2024-12-10T00:17:20.484Z","updated_at":"2026-05-30T02:02:25.048Z","avatar_url":"https://github.com/terraform-ibm-modules.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudant 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[![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-cloudant?logo=GitHub\u0026sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-cloudant/releases/latest)\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[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)\n[![Terraform Registry](https://img.shields.io/badge/terraform-registry-623CE4?logo=terraform)](https://registry.terraform.io/modules/terraform-ibm-modules/cloudant/ibm/latest)\n\n\nThis module supports provisioning a instance of the IBM Cloudant service. With a Lite plan, the instance is provisioned on a multi-tenant environment. With a standard plan, the instance can be provisioned either on a multi-tenant or on a dedicated environment. For more information, see [Plans and provisioning](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-ibm-cloud-public).\n\n\u003c!-- BEGIN OVERVIEW HOOK --\u003e\n## Overview\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"#terraform-ibm-cloudant\"\u003eterraform-ibm-cloudant\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"./modules\"\u003eSubmodules\u003c/a\u003e\n    \u003cul\u003e\n      \u003cli\u003e\u003ca href=\"./modules/fscloud\"\u003efscloud\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"./examples\"\u003eExamples\u003c/a\u003e\n    \u003cul\u003e\n      \u003cli\u003e\n        \u003ca href=\"./examples/basic\"\u003eBasic cloudant instance and database creation\u003c/a\u003e\n        \u003ca href=\"https://cloud.ibm.com/schematics/workspaces/create?workspace_name=cloudant-basic-example\u0026repository=https://github.com/terraform-ibm-modules/terraform-ibm-cloudant/tree/main/examples/basic\"\u003e\u003cimg src=\"https://img.shields.io/badge/Deploy%20with%20IBM%20Cloud%20Schematics-0f62fe?style=flat\u0026logo=ibm\u0026logoColor=white\u0026labelColor=0f62fe\" alt=\"Deploy with IBM Cloud Schematics\" style=\"height: 16px; vertical-align: text-bottom; margin-left: 5px;\"\u003e\u003c/a\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\n        \u003ca href=\"./examples/complete\"\u003eCloudant instance, access controls, and rotation of credentials through Secret Manager\u003c/a\u003e\n        \u003ca href=\"https://cloud.ibm.com/schematics/workspaces/create?workspace_name=cloudant-complete-example\u0026repository=https://github.com/terraform-ibm-modules/terraform-ibm-cloudant/tree/main/examples/complete\"\u003e\u003cimg src=\"https://img.shields.io/badge/Deploy%20with%20IBM%20Cloud%20Schematics-0f62fe?style=flat\u0026logo=ibm\u0026logoColor=white\u0026labelColor=0f62fe\" alt=\"Deploy with IBM Cloud Schematics\" style=\"height: 16px; vertical-align: text-bottom; margin-left: 5px;\"\u003e\u003c/a\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\n        \u003ca href=\"./examples/fscloud\"\u003eFinancial Services Cloud profile example\u003c/a\u003e\n        \u003ca href=\"https://cloud.ibm.com/schematics/workspaces/create?workspace_name=cloudant-fscloud-example\u0026repository=https://github.com/terraform-ibm-modules/terraform-ibm-cloudant/tree/main/examples/fscloud\"\u003e\u003cimg src=\"https://img.shields.io/badge/Deploy%20with%20IBM%20Cloud%20Schematics-0f62fe?style=flat\u0026logo=ibm\u0026logoColor=white\u0026labelColor=0f62fe\" alt=\"Deploy with IBM Cloud Schematics\" style=\"height: 16px; vertical-align: text-bottom; margin-left: 5px;\"\u003e\u003c/a\u003e\n      \u003c/li\u003e\n    \u003c/ul\u003e\n    ℹ️ Ctrl/Cmd+Click or right-click on the Schematics deploy button to open in a new tab.\n  \u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"./solutions\"\u003eDeployable Architectures\u003c/a\u003e\n    \u003cul\u003e\n      \u003cli\u003e\u003ca href=\"./solutions/dedicated\"\u003eIBM Cloudant Dedicated on IBM Cloud Dedicated\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003c!-- END OVERVIEW HOOK --\u003e\n\n## cloudant-module\n\n### Usage\n\n#### Usage to create a cloudant instance on a multi-tenant environment:\n\n```hcl\nmodule \"cloudant\" {\n  source            = \"terraform-ibm-modules/cloudant/ibm\"\n  version           = \"X.X.X\" # Replace \"X.X.X\" with a release version to lock into a specific release\n  resource_group_id = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\n  instance_name     = \"my-cloudant-instance\"\n}\n```\n\n#### Usage to create a cloudant instance on a dedicated environment:\n\n```hcl\nmodule \"cloudant\" {\n  source            = \"terraform-ibm-modules/cloudant/ibm\"\n  version           = \"X.X.X\" # Replace \"X.X.X\" with a release version to lock into a specific release\n  resource_group_id = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\n  instance_name     = \"dedicated-cloudant-instance\"\n  environment_crn   = \"crn:\u003c...\u003e\" # CRN of dedicated environment\n}\n```\n\n### Required IAM access policies\n\nYou need the following permissions to run this module.\n\n- IAM Services\n    - Cloudant service\n        - `Manager` service access\n\n\n\u003c!-- Below content is automatically populated via pre-commit hook --\u003e\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.9.0 |\n| \u003ca name=\"requirement_ibm\"\u003e\u003c/a\u003e [ibm](#requirement\\_ibm) | \u003e= 1.88.0, \u003c 3.0.0 |\n\n### Modules\n\nNo modules.\n\n### Resources\n\n| Name | Type |\n|------|------|\n| [ibm_cloudant.cloudant_instance](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/cloudant) | resource |\n| [ibm_cloudant_database.cloudant_database](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/cloudant_database) | resource |\n| [ibm_resource_key.service_credentials](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_key) | resource |\n| [ibm_resource_tag.access_tags](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_tag) | resource |\n| [ibm_iam_access_tag.access_tag](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/iam_access_tag) | data source |\n\n### Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_access_tags\"\u003e\u003c/a\u003e [access\\_tags](#input\\_access\\_tags) | Add access management tags to the Cloudant instance to control access. [Learn more](https://cloud.ibm.com/docs/account?topic=account-tag\u0026interface=ui#create-access-console). | `list(string)` | `[]` | no |\n| \u003ca name=\"input_allow_credentials\"\u003e\u003c/a\u003e [allow\\_credentials](#input\\_allow\\_credentials) | Boolean value to allow authentication credentials. This will only be used if enable\\_cors is set to true. | `bool` | `true` | no |\n| \u003ca name=\"input_capacity\"\u003e\u003c/a\u003e [capacity](#input\\_capacity) | Number of blocks of throughput units. See https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-ibm-cloud-public#provisioned-throughput-capacity. Capacity modification is not supported for lite plan. | `number` | `1` | no |\n| \u003ca name=\"input_database_config\"\u003e\u003c/a\u003e [database\\_config](#input\\_database\\_config) | (Optional, List) The databases with their corresponding partitioning and shards to be created in the cloudant instance | \u003cpre\u003elist(object({\u003cbr/\u003e    db          = string\u003cbr/\u003e    partitioned = optional(bool)\u003cbr/\u003e    shards      = optional(number)\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_enable_cors\"\u003e\u003c/a\u003e [enable\\_cors](#input\\_enable\\_cors) | Boolean value to enable cross-origin resource sharing (CORS). | `bool` | `false` | no |\n| \u003ca name=\"input_environment_crn\"\u003e\u003c/a\u003e [environment\\_crn](#input\\_environment\\_crn) | Optional CRN of the IBM Cloudant Dedicated Hardware plan instance to provision a cloudant instance | `string` | `null` | no |\n| \u003ca name=\"input_include_data_events\"\u003e\u003c/a\u003e [include\\_data\\_events](#input\\_include\\_data\\_events) | Include data event types in events sent to IBM Cloud Activity Tracker. If set to false, only management events will be sent to Activity Tracker. | `bool` | `false` | no |\n| \u003ca name=\"input_instance_name\"\u003e\u003c/a\u003e [instance\\_name](#input\\_instance\\_name) | The name of the Cloudant instance | `string` | n/a | yes |\n| \u003ca name=\"input_legacy_credentials\"\u003e\u003c/a\u003e [legacy\\_credentials](#input\\_legacy\\_credentials) | Use both legacy credentials, in addition to IAM credentials for authentication. If set to false, use use only IAM credentials. | `bool` | `false` | no |\n| \u003ca name=\"input_origins\"\u003e\u003c/a\u003e [origins](#input\\_origins) | An array of strings that contain allowed origin domains. This value is only used if enable\\_cors is set to true. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_plan\"\u003e\u003c/a\u003e [plan](#input\\_plan) | The plan for the Cloudant instance. Standard or lite. | `string` | `\"standard\"` | no |\n| \u003ca name=\"input_region\"\u003e\u003c/a\u003e [region](#input\\_region) | The IBM Cloud region where the Cloudant instance will be provisioned. | `string` | `\"us-south\"` | no |\n| \u003ca name=\"input_resource_group_id\"\u003e\u003c/a\u003e [resource\\_group\\_id](#input\\_resource\\_group\\_id) | The Id of an existing IBM Cloud resource group where the instance will be grouped. | `string` | n/a | yes |\n| \u003ca name=\"input_service_credential_names\"\u003e\u003c/a\u003e [service\\_credential\\_names](#input\\_service\\_credential\\_names) | List of service credentials to create for the cloudant database, including name and optionally role and endpoint type. | \u003cpre\u003elist(object({\u003cbr/\u003e    name     = string\u003cbr/\u003e    role     = optional(string, \"Reader\")\u003cbr/\u003e    endpoint = optional(string, \"private\")\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_service_endpoints\"\u003e\u003c/a\u003e [service\\_endpoints](#input\\_service\\_endpoints) | Sets the endpoint of the instance, valid values are 'public', 'private', or 'public-and-private' | `string` | `\"public-and-private\"` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Add user resource tags to the Cloudant instance to organize, track, and manage costs. [Learn more](https://cloud.ibm.com/docs/account?topic=account-tag\u0026interface=ui#tag-types). | `list(string)` | `[]` | no |\n\n### Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_capacity\"\u003e\u003c/a\u003e [capacity](#output\\_capacity) | A number of blocks of throughput units |\n| \u003ca name=\"output_crn\"\u003e\u003c/a\u003e [crn](#output\\_crn) | CRN of the resource instance |\n| \u003ca name=\"output_db_map\"\u003e\u003c/a\u003e [db\\_map](#output\\_db\\_map) | A map of the Cloudant database names created and their respective IDs |\n| \u003ca name=\"output_instance_guid\"\u003e\u003c/a\u003e [instance\\_guid](#output\\_instance\\_guid) | Global identifier of the cloudant instance created |\n| \u003ca name=\"output_instance_id\"\u003e\u003c/a\u003e [instance\\_id](#output\\_instance\\_id) | The id of the cloudant instance created |\n| \u003ca name=\"output_instance_name\"\u003e\u003c/a\u003e [instance\\_name](#output\\_instance\\_name) | Name of the cloudant instance |\n| \u003ca name=\"output_instance_url\"\u003e\u003c/a\u003e [instance\\_url](#output\\_instance\\_url) | The dashboard URL to access resource |\n| \u003ca name=\"output_plan\"\u003e\u003c/a\u003e [plan](#output\\_plan) | The plan used to create cloudant instance |\n| \u003ca name=\"output_private_endpoint\"\u003e\u003c/a\u003e [private\\_endpoint](#output\\_private\\_endpoint) | The external private endpoint |\n| \u003ca name=\"output_public_endpoint\"\u003e\u003c/a\u003e [public\\_endpoint](#output\\_public\\_endpoint) | The external public endpoint |\n| \u003ca name=\"output_resource_group_name\"\u003e\u003c/a\u003e [resource\\_group\\_name](#output\\_resource\\_group\\_name) | The resource group name in which resource is provisioned |\n| \u003ca name=\"output_resource_keys_url\"\u003e\u003c/a\u003e [resource\\_keys\\_url](#output\\_resource\\_keys\\_url) | The relative path to the resource keys for the instance |\n| \u003ca name=\"output_service_credentials_json\"\u003e\u003c/a\u003e [service\\_credentials\\_json](#output\\_service\\_credentials\\_json) | Service credentials json map |\n| \u003ca name=\"output_service_credentials_object\"\u003e\u003c/a\u003e [service\\_credentials\\_object](#output\\_service\\_credentials\\_object) | Service credentials object |\n| \u003ca name=\"output_state\"\u003e\u003c/a\u003e [state](#output\\_state) | The current state of the instance |\n\u003c!-- END OF PRE-COMMIT-TERRAFORM DOCS 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## 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-cloudant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-cloudant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-ibm-modules%2Fterraform-ibm-cloudant/lists"}