Skip to content

Commit

Permalink
add d and r docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shuaib Bapputty committed Dec 1, 2023
1 parent a67552e commit 6128358
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 2 deletions.
4 changes: 2 additions & 2 deletions ibm/service/mqcloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ This area is primarily for IBM provider contributors and maintainers. For inform
* [Find out about contributing](../../../CONTRIBUTING.md) to the IBM provider!
* IBM Provider Docs: [Home](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs)
* IBM Provider Docs: [One of the resources](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/mqcloud_queue_manager)
* IBM API Docs: [IBM API Docs for ]()
* IBM SDK: [IBM SDK for ](https://github.com/IBM/appconfiguration-go-admin-sdk/tree/master/mqcloudv1)
* IBM API Docs: [IBM API Docs for IBM Cloud MQ on Cloud](https://test.cloud.ibm.com/apidocs/mq-on-cloud)
* IBM SDK: [IBM SDK for IBM Cloud MQ on Cloud](https://github.com/IBM/appconfiguration-go-admin-sdk/tree/master/mqcloudv1)
67 changes: 67 additions & 0 deletions website/docs/d/mqcloud_queue_manager.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
layout: "ibm"
page_title: "IBM : ibm_mqcloud_queue_manager"
description: |-
Get information about mqcloud_queue_manager
subcategory: "MQ on Cloud"
---

# ibm_mqcloud_queue_manager

Provides a read-only data source to retrieve information about a mqcloud_queue_manager. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

## Example Usage

```hcl
data "ibm_mqcloud_queue_manager" "mqcloud_queue_manager" {
name = ibm_mqcloud_queue_manager.mqcloud_queue_manager_instance.name
service_instance_guid = ibm_mqcloud_queue_manager.mqcloud_queue_manager_instance.service_instance_guid
}
```

## Argument Reference

You can specify the following arguments for this data source.

* `name` - (Optional, String) A queue manager name conforming to MQ restrictions.
* Constraints: The maximum length is `48` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9._]*$/`.
* `service_instance_guid` - (Required, Forces new resource, String) The GUID that uniquely identifies the MQ on Cloud service instance.
* Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/`.

## Attribute Reference

After your data source is created, you can read values from the following attributes.

* `id` - The unique identifier of the mqcloud_queue_manager.
* `first` - (List) Link to first page of results.
Nested schema for **first**:
* `href` - (String) The URL of the page the link goes to.

* `previous` - (List) Link to previous page of results.
Nested schema for **previous**:
* `href` - (String) The URL of the page the link goes to.

* `queue_managers` - (List) List of queue managers.
* Constraints: The maximum length is `50` items. The minimum length is `0` items.
Nested schema for **queue_managers**:
* `administrator_api_endpoint_url` - (String) The url through which to access the Admin REST APIs for this queue manager.
* `available_upgrade_versions_uri` - (String) The uri through which the available versions to upgrade to can be found for this queue manager.
* `connection_info_uri` - (String) The uri through which the CDDT for this queue manager can be obtained.
* `date_created` - (String) RFC3339 formatted UTC date for when the queue manager was created.
* `display_name` - (String) A displayable name for the queue manager - limited only in length.
* Constraints: The maximum length is `150` characters.
* `href` - (String) The URL for this queue manager.
* `id` - (String) The ID of the queue manager which was allocated on creation, and can be used for delete calls.
* `location` - (String) The locations in which the queue manager could be deployed.
* Constraints: The maximum length is `150` characters. The minimum length is `2` characters. The value must match regular expression `/^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$/`.
* `name` - (String) A queue manager name conforming to MQ restrictions.
* Constraints: The maximum length is `48` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9._]*$/`.
* `rest_api_endpoint_url` - (String) The url through which to access REST APIs for this queue manager.
* `size` - (String) The queue manager sizes of deployment available. Deployment of lite queue managers for aws_us_east_1 and aws_eu_west_1 locations is not available.
* Constraints: Allowable values are: `lite`, `xsmall`, `small`, `medium`, `large`.
* `status_uri` - (String) A reference uri to get deployment status of the queue manager.
* `upgrade_available` - (Boolean) Describes whether an upgrade is available for this queue manager.
* `version` - (String) The MQ version of the queue manager.
* Constraints: The maximum length is `15` characters. The minimum length is `7` characters. The value must match regular expression `/^[0-9]+.[0-9]+.[0-9]+_[0-9]+$/`.
* `web_console_url` - (String) The url through which to access the web console for this queue manager.

38 changes: 38 additions & 0 deletions website/docs/d/mqcloud_queue_manager_status.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
layout: "ibm"
page_title: "IBM : ibm_mqcloud_queue_manager_status"
description: |-
Get information about mqcloud_queue_manager_status
subcategory: "MQ on Cloud"
---

# ibm_mqcloud_queue_manager_status

Provides a read-only data source to retrieve information about mqcloud_queue_manager_status. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

## Example Usage

```hcl
data "ibm_mqcloud_queue_manager_status" "mqcloud_queue_manager_status" {
queue_manager_id = "b8e1aeda078009cf3db74e90d5d42328"
service_instance_guid = "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"
}
```

## Argument Reference

You can specify the following arguments for this data source.

* `queue_manager_id` - (Required, Forces new resource, String) The id of the queue manager to retrieve its full details.
* Constraints: The maximum length is `32` characters. The minimum length is `32` characters. The value must match regular expression `/^[0-9a-fA-F]{32}$/`.
* `service_instance_guid` - (Required, Forces new resource, String) The GUID that uniquely identifies the MQ on Cloud service instance.
* Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/`.

## Attribute Reference

After your data source is created, you can read values from the following attributes.

* `id` - The unique identifier of the mqcloud_queue_manager_status.
* `status` - (String) The deploying and failed states are not queue manager states, they are states which can occur when the request to deploy has been fired, or with that request has failed without producing a queue manager to have any state. The other states map to the queue manager states. State "ending" is either quiesing or ending immediately. State "ended" is either ended normally or endedimmediately. The others map one to one with queue manager states.
* Constraints: Allowable values are: `initializing`, `deploying`, `starting`, `running`, `stopping`, `stopped`, `status_not_available`, `deleting`, `failed`, `upgrading_version`, `updating_revision`, `initialization_failed`, `restoring_queue_manager`, `restoring_config`, `restore_failed`, `suspended`, `resumable`.

74 changes: 74 additions & 0 deletions website/docs/r/mqcloud_queue_manager.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
layout: "ibm"
page_title: "IBM : ibm_mqcloud_queue_manager"
description: |-
Manages mqcloud_queue_manager.
subcategory: "MQ on Cloud"
---

# ibm_mqcloud_queue_manager

Create, update, and delete mqcloud_queue_managers with this resource.

## Example Usage

```hcl
resource "ibm_mqcloud_queue_manager" "mqcloud_queue_manager_instance" {
display_name = "A test queue manager"
location = "reserved-eu-fr-cluster-f884"
name = "testqm"
service_instance_guid = "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"
size = "lite"
version = "9.3.2_2"
}
```

## Argument Reference

You can specify the following arguments for this resource.

* `display_name` - (Optional, String) A displayable name for the queue manager - limited only in length.
* Constraints: The maximum length is `150` characters.
* `location` - (Required, String) The locations in which the queue manager could be deployed.
* Constraints: The maximum length is `150` characters. The minimum length is `2` characters. The value must match regular expression `/^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$/`.
* `name` - (Required, String) A queue manager name conforming to MQ restrictions.
* Constraints: The maximum length is `48` characters. The minimum length is `1` character. The value must match regular expression `/^[a-zA-Z0-9._]*$/`.
* `service_instance_guid` - (Required, Forces new resource, String) The GUID that uniquely identifies the MQ on Cloud service instance.
* Constraints: The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/`.
* `size` - (Required, String) The queue manager sizes of deployment available. Deployment of lite queue managers for aws_us_east_1 and aws_eu_west_1 locations is not available.
* Constraints: Allowable values are: `lite`, `xsmall`, `small`, `medium`, `large`.
* `version` - (Optional, String) The MQ version of the queue manager.
* Constraints: The maximum length is `15` characters. The minimum length is `7` characters. The value must match regular expression `/^[0-9]+.[0-9]+.[0-9]+_[0-9]+$/`.

## Attribute Reference

After your resource is created, you can read values from the listed arguments and the following attributes.

* `id` - The unique identifier of the mqcloud_queue_manager.
* `administrator_api_endpoint_url` - (String) The url through which to access the Admin REST APIs for this queue manager.
* `available_upgrade_versions_uri` - (String) The uri through which the available versions to upgrade to can be found for this queue manager.
* `connection_info_uri` - (String) The uri through which the CDDT for this queue manager can be obtained.
* `date_created` - (String) RFC3339 formatted UTC date for when the queue manager was created.
* `href` - (String) The URL for this queue manager.
* `queue_manager_id` - (String) The ID of the queue manager which was allocated on creation, and can be used for delete calls.
* `rest_api_endpoint_url` - (String) The url through which to access REST APIs for this queue manager.
* `status_uri` - (String) A reference uri to get deployment status of the queue manager.
* `upgrade_available` - (Boolean) Describes whether an upgrade is available for this queue manager.
* `web_console_url` - (String) The url through which to access the web console for this queue manager.


## Import

You can import the `ibm_mqcloud_queue_manager` resource by using `id`.
The `id` property can be formed from `service_instance_guid`, and `queue_manager_id` in the following format:

<pre>
&lt;service_instance_guid&gt;/&lt;queue_manager_id&gt;
</pre>
* `service_instance_guid`: A string in the format `a2b4d4bc-dadb-4637-bcec-9b7d1e723af8`. The GUID that uniquely identifies the MQ on Cloud service instance.
* `queue_manager_id`: A string. The ID of the queue manager which was allocated on creation, and can be used for delete calls.

# Syntax
<pre>
$ terraform import ibm_mqcloud_queue_manager.mqcloud_queue_manager &lt;service_instance_guid&gt;/&lt;queue_manager_id&gt;
</pre>

0 comments on commit 6128358

Please sign in to comment.