Skip to content

Commit

Permalink
update_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prasad-1729 committed Nov 19, 2024
1 parent 702291a commit 2a18b2a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions website/docs/d/db2_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-
Retrieve information about an existing [IBM Db2 SaaS Instance](https://cloud.ibm.com/docs/cloud-databases).

**Note**
Configuration of an IBM Cloud Db2 SaaS Instance `data_source` requires that the `region` parameter is set for the IBM provider in the `provider.tf`. The region must be the same as the `location` that the IBM Cloud Databases instance is deployed into.A `terraform refresh` of the `data_source` fails if the region and the location differ.
Configuration of an IBM Db2 SaaS on IBM Cloud Instance `data_source` requires that the `region` parameter is set for the IBM provider in the `provider.tf`. The region must be the same as the `location` that the IBM Cloud Databases instance is deployed into.A `terraform refresh` of the `data_source` fails if the region and the location differ.

## Example usage
The following example retrieves information about the `db2_instance` instance in `us-south`.
Expand All @@ -28,19 +28,19 @@ data "ibm_db2" "db2_instance" {
## Argument reference
Review the argument reference that you can specify for your data source.

- `name` - (Required, String) The name of the IBM Cloud Db2 SaaS instance. IBM Cloud does not enforce that service names are unique and it is possible that duplicate service names exist. The first located service instance is used by Terraform. The name must not include spaces.
- `location` - (Optional, String) The location where the IBM Cloud Db2 SaaS instance is deployed into.
- `resource_group_id`- (Optional, String) The ID of the resource group where the IBM Cloud Db2 SaaS instance is deployed into. The default is `default`.
- `name` - (Required, String) The name of the IBM Db2 SaaS on IBM Cloud instance. IBM Cloud does not enforce that service names are unique and it is possible that duplicate service names exist. The first located service instance is used by Terraform. The name must not include spaces.
- `location` - (Optional, String) The location where the IBM Db2 SaaS on IBM Cloud instance is deployed into.
- `resource_group_id`- (Optional, String) The ID of the resource group where the IBM Db2 SaaS on IBM Cloud instance is deployed into. The default is `default`.
- `service` - (Optional, String) The service type of the instance. To retrieve this value, run `ibmcloud catalog service-marketplace` or `ibmcloud catalog search`.

## Attribute reference
In addition to all argument references list, you can access the following attribute references after your data source is created.

- `guid` - (String) The unique identifier of the IBM Cloud Db2 SaaS instance.
- `resource_crn` - (String) The unique identifier(CRN) of the IBM Cloud Db2 SaaS instance.
- `plan` - (String) The service plan of the IBM Cloud Db2 SaaS instance.
- `location` - (String) The location where the IBM Cloud Db2 SaaS instance is deployed into.
- `status` - (String) The status of the IBM Cloud Db2 SaaS instance.
- `guid` - (String) The unique identifier of the IBM Db2 SaaS on IBM Cloud instance.
- `resource_crn` - (String) The unique identifier(CRN) of the IBM Db2 SaaS on IBM Cloud instance.
- `plan` - (String) The service plan of the IBM Db2 SaaS on IBM Cloud instance.
- `location` - (String) The location where the IBM Db2 SaaS on IBM Cloud instance is deployed into.
- `status` - (String) The status of the IBM Db2 SaaS on IBM Cloud instance.
- `version` - (String) The database version.
- `platform_options`- (String) The CRN of key protect key.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/db2_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# ibm_db2

Create or delete an IBM Cloud Db2 SaaS instance. The `ibmcloud_api_key` that are used by Terraform should grant IAM rights to create and modify IBM Cloud Db2 Databases and have access to the resource group the Db2 SaaS instance is associated with. For more information, see [documentation](https://cloud.ibm.com/docs/Db2onCloud?topic=Db2onCloud-getting-started) to manage Db2 SaaS instances.
Create or delete an IBM Db2 SaaS on IBM Cloud instance. The `ibmcloud_api_key` that are used by Terraform should grant IAM rights to create and modify IBM Cloud Db2 Databases and have access to the resource group the Db2 SaaS instance is associated with. For more information, see [documentation](https://cloud.ibm.com/docs/Db2onCloud?topic=Db2onCloud-getting-started) to manage Db2 SaaS instances.


Configuration of an Db2 SaaS resource requires that the `region` parameter is set for the IBM provider in the `provider.tf` to be the same as the target Db2 SaaS `location/region`. If the Terraform configuration needs to deploy resources into multiple regions, provider alias can be used. For more information, see [Terraform provider configuration](https://www.terraform.io/docs/configuration/providers.html#multiple-provider-instances).
Expand Down

0 comments on commit 2a18b2a

Please sign in to comment.