Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dis): fix docs issues. #1003

Merged
merged 1 commit into from
Sep 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/resources/dis_stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ resource "flexibleengine_dis_stream" "stream" {

The following arguments are supported:

* `region` - (Optional, String, ForceNew) Specifies the region in which to create the DIS stream resource.
If omitted, the provider-level region will be used. Changing this will create a new DIS stream resource.

* `name` - (Required, String, ForceNew) Specifies the name of the DIS stream to be created.
Changing this will create a new resource.

Expand All @@ -36,20 +39,22 @@ The following arguments are supported:
+ **ADVANCED stream:**
Each partition supports a read speed of up to 10 MB/s and a write speed of up to 2000 records/s and 5 MB/s.

* `retention_period` - (Optional, Int, ForceNew) Specifies the number of hours for which data from the stream
* `data_duration` - (Optional, Int, ForceNew) Specifies the number of hours for which data from the stream
will be retained in DIS. The value ranges from 24 to 168 and defaults to 24. Changing this will create a new resource.

## Attributes Reference
## Attribute Reference

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

* `id` - The resource ID which equals to stream name.

* `status` - Status of stream: `CREATING`,`RUNNING`,`TERMINATING`,`TERMINATED`,`FROZEN`.

* `partitions` - The information of stream partitions. Structure is documented below.
* `partitions` - The information of stream partitions. The [partitions](#dis_partitions) object structure is
documented below.

The `partitions` block contains:
<a name="dis_partitions"></a>
The `partitions` block supports:

* `id` - The ID of the partition.

Expand Down