Skip to content

Commit c7af5a4

Browse files
authored
fix(vpc): [127892253] tencentcloud_vpc_flow_log update doc (#3566)
* add * add * add
1 parent b24fd3a commit c7af5a4

File tree

3 files changed

+27
-24
lines changed

3 files changed

+27
-24
lines changed

.changelog/3566.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:enhancement
2+
resource/tencentcloud_vpc_flow_log: update doc
3+
```

tencentcloud/services/fl/resource_tc_vpc_flow_log.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,62 +30,62 @@ func ResourceTencentCloudVpcFlowLog() *schema.Resource {
3030
"flow_log_name": {
3131
Required: true,
3232
Type: schema.TypeString,
33-
Description: "Specify flow log name.",
33+
Description: "The name of the flow log instance.",
3434
},
3535
"resource_type": {
3636
Required: true,
3737
Type: schema.TypeString,
38-
Description: "Specify resource type. NOTE: Only support `NETWORKINTERFACE` for now. Values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, `DCG`.",
38+
Description: "The type of resource associated with the flow log. Valid values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, and `DCG`.",
3939
},
4040
"resource_id": {
4141
Required: true,
4242
Type: schema.TypeString,
43-
Description: "Specify resource unique Id of `resource_type` configured.",
43+
Description: "The unique ID of the resource.",
4444
},
4545
"traffic_type": {
4646
Required: true,
4747
Type: schema.TypeString,
48-
Description: "Specify log traffic type, values: `ACCEPT`, `REJECT`, `ALL`.",
48+
Description: "Type of the flow logs to be collected. Valid values: `ACCEPT`, `REJECT` and `ALL`.",
4949
},
5050
"vpc_id": {
5151
Optional: true,
5252
Type: schema.TypeString,
53-
Description: "Specify vpc Id, ignore while `resource_type` is `CCN` (unsupported) but required while other types.",
53+
Description: "The VPC ID or unique ID of the resource. We recommend using the unique ID. This parameter is required unless the `ResourceType` is set to `CCN`.",
5454
},
5555
"flow_log_description": {
5656
Optional: true,
5757
Type: schema.TypeString,
58-
Description: "Specify flow Log description.",
58+
Description: "The description of the flow log.",
5959
},
6060
"cloud_log_id": {
6161
Optional: true,
6262
Type: schema.TypeString,
63-
Description: "Specify flow log storage id, just set cls topic id.",
63+
Description: "The storage ID of the flow log.",
6464
},
6565
"storage_type": {
6666
Optional: true,
6767
Type: schema.TypeString,
68-
Description: "Specify consumer type, values: `cls`, `ckafka`.",
68+
Description: "Consumer types: `cls` and `ckafka`.",
6969
},
7070
"flow_log_storage": {
7171
Optional: true,
7272
Computed: true,
7373
Type: schema.TypeList,
7474
MaxItems: 1,
75-
Description: "Specify consumer detail, required while `storage_type` is `ckafka`.",
75+
Description: "Information of the flow log consumer, required while `storage_type` is `ckafka`.",
7676
Elem: &schema.Resource{
7777
Schema: map[string]*schema.Schema{
7878
"storage_id": {
7979
Type: schema.TypeString,
8080
Optional: true,
8181
Computed: true,
82-
Description: "Specify storage instance id, required while `storage_type` is `ckafka`.",
82+
Description: "Storage instance ID, required while `storage_type` is `ckafka`.",
8383
},
8484
"storage_topic": {
8585
Type: schema.TypeString,
8686
Optional: true,
8787
Computed: true,
88-
Description: "Specify storage topic id, required while `storage_type` is `ckafka`.",
88+
Description: "Topic ID, required while `storage_type` is `ckafka`.",
8989
},
9090
},
9191
},
@@ -94,7 +94,7 @@ func ResourceTencentCloudVpcFlowLog() *schema.Resource {
9494
Type: schema.TypeString,
9595
Optional: true,
9696
Computed: true,
97-
Description: "Specify flow log storage region, default using current.",
97+
Description: "The region corresponding to the flow log storage ID. If not passed in, this field defaults to the current region.",
9898
},
9999
"tags": {
100100
Type: schema.TypeMap,

website/docs/r/vpc_flow_log.html.markdown

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -117,22 +117,22 @@ resource "tencentcloud_vpc_flow_log" "example" {
117117

118118
The following arguments are supported:
119119

120-
* `flow_log_name` - (Required, String) Specify flow log name.
121-
* `resource_id` - (Required, String) Specify resource unique Id of `resource_type` configured.
122-
* `resource_type` - (Required, String) Specify resource type. NOTE: Only support `NETWORKINTERFACE` for now. Values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, `DCG`.
123-
* `traffic_type` - (Required, String) Specify log traffic type, values: `ACCEPT`, `REJECT`, `ALL`.
124-
* `cloud_log_id` - (Optional, String) Specify flow log storage id, just set cls topic id.
125-
* `cloud_log_region` - (Optional, String) Specify flow log storage region, default using current.
126-
* `flow_log_description` - (Optional, String) Specify flow Log description.
127-
* `flow_log_storage` - (Optional, List) Specify consumer detail, required while `storage_type` is `ckafka`.
128-
* `storage_type` - (Optional, String) Specify consumer type, values: `cls`, `ckafka`.
120+
* `flow_log_name` - (Required, String) The name of the flow log instance.
121+
* `resource_id` - (Required, String) The unique ID of the resource.
122+
* `resource_type` - (Required, String) The type of resource associated with the flow log. Valid values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, and `DCG`.
123+
* `traffic_type` - (Required, String) Type of the flow logs to be collected. Valid values: `ACCEPT`, `REJECT` and `ALL`.
124+
* `cloud_log_id` - (Optional, String) The storage ID of the flow log.
125+
* `cloud_log_region` - (Optional, String) The region corresponding to the flow log storage ID. If not passed in, this field defaults to the current region.
126+
* `flow_log_description` - (Optional, String) The description of the flow log.
127+
* `flow_log_storage` - (Optional, List) Information of the flow log consumer, required while `storage_type` is `ckafka`.
128+
* `storage_type` - (Optional, String) Consumer types: `cls` and `ckafka`.
129129
* `tags` - (Optional, Map) Tag description list.
130-
* `vpc_id` - (Optional, String) Specify vpc Id, ignore while `resource_type` is `CCN` (unsupported) but required while other types.
130+
* `vpc_id` - (Optional, String) The VPC ID or unique ID of the resource. We recommend using the unique ID. This parameter is required unless the `ResourceType` is set to `CCN`.
131131

132132
The `flow_log_storage` object supports the following:
133133

134-
* `storage_id` - (Optional, String) Specify storage instance id, required while `storage_type` is `ckafka`.
135-
* `storage_topic` - (Optional, String) Specify storage topic id, required while `storage_type` is `ckafka`.
134+
* `storage_id` - (Optional, String) Storage instance ID, required while `storage_type` is `ckafka`.
135+
* `storage_topic` - (Optional, String) Topic ID, required while `storage_type` is `ckafka`.
136136

137137
## Attributes Reference
138138

0 commit comments

Comments
 (0)