diff --git a/.changelog/3566.txt b/.changelog/3566.txt new file mode 100644 index 0000000000..bcca5f245f --- /dev/null +++ b/.changelog/3566.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/tencentcloud_vpc_flow_log: update doc +``` diff --git a/tencentcloud/services/fl/resource_tc_vpc_flow_log.go b/tencentcloud/services/fl/resource_tc_vpc_flow_log.go index 57092d1913..ad4de5bfd2 100644 --- a/tencentcloud/services/fl/resource_tc_vpc_flow_log.go +++ b/tencentcloud/services/fl/resource_tc_vpc_flow_log.go @@ -30,62 +30,62 @@ func ResourceTencentCloudVpcFlowLog() *schema.Resource { "flow_log_name": { Required: true, Type: schema.TypeString, - Description: "Specify flow log name.", + Description: "The name of the flow log instance.", }, "resource_type": { Required: true, Type: schema.TypeString, - Description: "Specify resource type. NOTE: Only support `NETWORKINTERFACE` for now. Values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, `DCG`.", + Description: "The type of resource associated with the flow log. Valid values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, and `DCG`.", }, "resource_id": { Required: true, Type: schema.TypeString, - Description: "Specify resource unique Id of `resource_type` configured.", + Description: "The unique ID of the resource.", }, "traffic_type": { Required: true, Type: schema.TypeString, - Description: "Specify log traffic type, values: `ACCEPT`, `REJECT`, `ALL`.", + Description: "Type of the flow logs to be collected. Valid values: `ACCEPT`, `REJECT` and `ALL`.", }, "vpc_id": { Optional: true, Type: schema.TypeString, - Description: "Specify vpc Id, ignore while `resource_type` is `CCN` (unsupported) but required while other types.", + 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`.", }, "flow_log_description": { Optional: true, Type: schema.TypeString, - Description: "Specify flow Log description.", + Description: "The description of the flow log.", }, "cloud_log_id": { Optional: true, Type: schema.TypeString, - Description: "Specify flow log storage id, just set cls topic id.", + Description: "The storage ID of the flow log.", }, "storage_type": { Optional: true, Type: schema.TypeString, - Description: "Specify consumer type, values: `cls`, `ckafka`.", + Description: "Consumer types: `cls` and `ckafka`.", }, "flow_log_storage": { Optional: true, Computed: true, Type: schema.TypeList, MaxItems: 1, - Description: "Specify consumer detail, required while `storage_type` is `ckafka`.", + Description: "Information of the flow log consumer, required while `storage_type` is `ckafka`.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "storage_id": { Type: schema.TypeString, Optional: true, Computed: true, - Description: "Specify storage instance id, required while `storage_type` is `ckafka`.", + Description: "Storage instance ID, required while `storage_type` is `ckafka`.", }, "storage_topic": { Type: schema.TypeString, Optional: true, Computed: true, - Description: "Specify storage topic id, required while `storage_type` is `ckafka`.", + Description: "Topic ID, required while `storage_type` is `ckafka`.", }, }, }, @@ -94,7 +94,7 @@ func ResourceTencentCloudVpcFlowLog() *schema.Resource { Type: schema.TypeString, Optional: true, Computed: true, - Description: "Specify flow log storage region, default using current.", + Description: "The region corresponding to the flow log storage ID. If not passed in, this field defaults to the current region.", }, "tags": { Type: schema.TypeMap, diff --git a/website/docs/r/vpc_flow_log.html.markdown b/website/docs/r/vpc_flow_log.html.markdown index 1ea250a79d..5811989cf9 100644 --- a/website/docs/r/vpc_flow_log.html.markdown +++ b/website/docs/r/vpc_flow_log.html.markdown @@ -117,22 +117,22 @@ resource "tencentcloud_vpc_flow_log" "example" { The following arguments are supported: -* `flow_log_name` - (Required, String) Specify flow log name. -* `resource_id` - (Required, String) Specify resource unique Id of `resource_type` configured. -* `resource_type` - (Required, String) Specify resource type. NOTE: Only support `NETWORKINTERFACE` for now. Values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, `DCG`. -* `traffic_type` - (Required, String) Specify log traffic type, values: `ACCEPT`, `REJECT`, `ALL`. -* `cloud_log_id` - (Optional, String) Specify flow log storage id, just set cls topic id. -* `cloud_log_region` - (Optional, String) Specify flow log storage region, default using current. -* `flow_log_description` - (Optional, String) Specify flow Log description. -* `flow_log_storage` - (Optional, List) Specify consumer detail, required while `storage_type` is `ckafka`. -* `storage_type` - (Optional, String) Specify consumer type, values: `cls`, `ckafka`. +* `flow_log_name` - (Required, String) The name of the flow log instance. +* `resource_id` - (Required, String) The unique ID of the resource. +* `resource_type` - (Required, String) The type of resource associated with the flow log. Valid values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, and `DCG`. +* `traffic_type` - (Required, String) Type of the flow logs to be collected. Valid values: `ACCEPT`, `REJECT` and `ALL`. +* `cloud_log_id` - (Optional, String) The storage ID of the flow log. +* `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. +* `flow_log_description` - (Optional, String) The description of the flow log. +* `flow_log_storage` - (Optional, List) Information of the flow log consumer, required while `storage_type` is `ckafka`. +* `storage_type` - (Optional, String) Consumer types: `cls` and `ckafka`. * `tags` - (Optional, Map) Tag description list. -* `vpc_id` - (Optional, String) Specify vpc Id, ignore while `resource_type` is `CCN` (unsupported) but required while other types. +* `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`. The `flow_log_storage` object supports the following: -* `storage_id` - (Optional, String) Specify storage instance id, required while `storage_type` is `ckafka`. -* `storage_topic` - (Optional, String) Specify storage topic id, required while `storage_type` is `ckafka`. +* `storage_id` - (Optional, String) Storage instance ID, required while `storage_type` is `ckafka`. +* `storage_topic` - (Optional, String) Topic ID, required while `storage_type` is `ckafka`. ## Attributes Reference