Skip to content

Commit df254e1

Browse files
committed
website/docs/functions: populate user_agent docs
1 parent 519bb26 commit df254e1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

website/docs/functions/user_agent.html.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@ subcategory: ""
33
layout: "aws"
44
page_title: "AWS: user_agent"
55
description: |-
6-
Formats a User-Agent product for use with the user_agent argument in the provider or provider_meta block..
6+
Formats a User-Agent product for use with the `user_agent` argument in the `provider` or `provider_meta` block.
77
---
88
# Function: user_agent
99

10-
~> Provider-defined functions are supported in Terraform 1.8 and later.
11-
12-
Formats a User-Agent product for use with the user_agent argument in the provider or provider_meta block..
10+
Formats a User-Agent product for use with the `user_agent` argument in the `provider` or `provider_meta` block.
1311

1412
## Example Usage
1513

1614
```terraform
17-
# result: foo-bar
15+
# result: "example-module/0.0.1 (example comment)"
1816
output "example" {
19-
value = provider::aws::user_agent("foo")
17+
value = provider::aws::user_agent("example-module", "0.0.1", "example comment")
2018
}
2119
```
2220

2321
## Signature
2422

2523
```text
26-
user_agent(arg string) string
24+
user_agent(product_name string, product_version string, comment string) string
2725
```
2826

2927
## Arguments
3028

31-
1. `arg` (String) Example argument description.
29+
1. `product_name` (String) Product name.
30+
1. `product_version` (String) Product version.
31+
1. `comment` (String) Comment describing any additional product details.

0 commit comments

Comments
 (0)