Skip to content

Commit

Permalink
docs(dms): fix docs issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
Zippo-Wang committed Sep 18, 2023
1 parent 9d08db8 commit b510809
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 26 deletions.
10 changes: 7 additions & 3 deletions docs/data-sources/dms_kafka_instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ data "flexibleengine_dms_kafka_instances" "test" {

* `include_failure` - (Optional, Bool) Specifies whether the query results contain instances that failed to create.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The data source ID.

* `instances` - The result of the query's list of kafka instances. The structure is documented below.
* `instances` - The result of the query's list of kafka instances. The [instances](#dms_instances) object structure
is documented below.

<a name="dms_instances"></a>
The `instances` block supports:

* `id` - The instance ID.
Expand Down Expand Up @@ -122,8 +124,10 @@ The `instances` block supports:

* `tags` - The key/value pairs to associate with the instance.

* `cross_vpc_accesses` - Indicates the Access information of cross-VPC. The structure is documented below.
* `cross_vpc_accesses` - Indicates the Access information of cross-VPC. The [cross_vpc_accesses](#dms_cross_vpc_accesses)
object structure is documented below.

<a name="dms_cross_vpc_accesses"></a>
The `cross_vpc_accesses` block supports:

* `listener_ip` - The listener IP address.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/dms_product.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "flexibleengine_dms_product" "product1" {

* `engine` - (Optional, String) Specifies the name of a message engine. Only **kafka** is supported.

* `version` - (Optional, String) Specifies the version of a message engine. The default value is **2.3.0**.
* `engine_version` - (Optional, String) Specifies the version of a message engine. The default value is **2.3.0**.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/dms_rocketmq_broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The following arguments are supported:
* `region` - (Optional, String) Specifies the region in which to query the data source.
If omitted, the provider-level region will be used.

* `instance_id` - (Optional, String) Specifies the ID of the rocketMQ instance.
* `instance_id` - (Required, String) Specifies the ID of the rocketMQ instance.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/dms_rocketmq_instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ The following arguments are supported:
* `exact_match_name` - (Optional, String) Specifies whether to search for the instance that precisely matches a
specified instance name. Value options: **true**, **false**. Defaults to **false**.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The resource ID.

* `instances` - Indicates the list of DMS RocketMQ instances.
The [Instance](#DmsRocketMQInstances_Instance) structure is documented below.
The [instances](#DmsRocketMQInstances_Instance) object structure is documented below.

<a name="DmsRocketMQInstances_Instance"></a>
The `instances` block supports:
Expand Down Expand Up @@ -87,7 +87,7 @@ The `instances` block supports:
* `ssl_enable` - Indicates whether the RocketMQ SASL_SSL is enabled. Defaults to false.

* `cross_vpc_accesses` - Indicates the Cross-VPC access information.
The [CrossVpc](#DmsRocketMQInstances_InstanceCrossVpc) structure is documented below.
The [cross_vpc_accesses](#DmsRocketMQInstances_InstanceCrossVpc) object structure is documented below.

* `storage_spec_code` - Indicates the storage I/O specification.

Expand All @@ -114,7 +114,7 @@ The `instances` block supports:
<a name="DmsRocketMQInstances_InstanceCrossVpc"></a>
The `cross_vpc_accesses` block supports:

* `lisenter_ip` - Indicates the IP of the listener.
* `listener_ip` - Indicates the IP of the listener.

* `advertised_ip` - Indicates the advertised IP.

Expand Down
12 changes: 10 additions & 2 deletions docs/resources/dms_kafka_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,10 @@ The following arguments are supported:
topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is
produced to or consumed from a topic that does not exist. Changing this creates a new instance resource.

* `tags` - (Optional, Map) Specifies the key/value pairs to associate with the DMS Kafka instance.
* `tags` - (Optional, Map, ForceNew) Specifies the key/value pairs to associate with the DMS Kafka instance.
Changing this will create a new resource.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand All @@ -163,6 +164,13 @@ In addition to all arguments above, the following attributes are exported:
* `ssl_enable` - Indicates whether the Kafka SASL_SSL is enabled.
* `created_at` - Indicates the creation time of the DMS Kafka instance.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 30 minutes.
* `delete` - Default is 30 minutes.

## Import

DMS Kafka instance can be imported using the instance id, e.g.
Expand Down
10 changes: 9 additions & 1 deletion docs/resources/dms_rocketmq_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The following arguments are supported:

* `retention_policy` - (Optional, Bool) Specifies the ACL access control.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand Down Expand Up @@ -140,6 +140,14 @@ In addition to all arguments above, the following attributes are exported:

* `resource_spec_code` - Indicates the resource specifications.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 50 minutes.
* `update` - Default is 50 minutes.
* `delete` - Default is 15 minutes.

## Import

The rocketmq instance can be imported using the `id`, e.g.
Expand Down
21 changes: 10 additions & 11 deletions docs/resources/dms_rocketmq_topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,16 @@ The following arguments are supported:
If omitted, the provider-level region will be used. Changing this parameter will create a new resource.

* `instance_id` - (Required, String, ForceNew) Specifies the ID of the rocketMQ instance.

Changing this parameter will create a new resource.

* `name` - (Required, String, ForceNew) Specifies the name of the topic.

Changing this parameter will create a new resource.

* `brokers` - (Required, List, ForceNew) Specifies the list of associated brokers of the topic.

Changing this parameter will create a new resource.
The [BrokerRef](#DmsRocketMQTopic_BrokerRef) structure is documented below.
The [brokers](#dms_arg_brokers) structure is documented below.

* `queue_num` - (Optional, Int, ForceNew) Specifies the number of queues. Default to 3.

Changing this parameter will create a new resource.

* `permission` - (Optional, String) Specifies the permissions of the topic.
Expand All @@ -54,19 +50,22 @@ The following arguments are supported:

* `total_write_queue_num` - (Optional, Int) Specifies the total number of write queues.

<a name="DmsRocketMQTopic_BrokerRef"></a>
The `BrokerRef` block supports:
<a name="dms_arg_brokers"></a>
The `brokers` block supports:

* `name` - (Optional, String) Indicates the name of the broker.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - The resource ID.

<a name="DmsRocketMQTopic_BrokerRef"></a>
The `BrokerRef` block supports:

* `brokers` - Specifies the list of associated brokers of the topic.
The [brokers](#dms_attr_brokers) structure is documented below.

<a name="dms_attr_brokers"></a>
The `brokers` block supports:

* `read_queue_num` - Indicates the read queues number of the broker. It's useless when create a topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ func testAccCheckDmsProductDataSourceID(n string) resource.TestCheckFunc {

var testAccDmsProductDataSource_basic = fmt.Sprintf(`
data "flexibleengine_dms_product" "test" {
bandwidth = "100MB"
bandwidth = "100MB"
engine_version = "2.3.0"
}
`)

0 comments on commit b510809

Please sign in to comment.