-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cdktf: update index.md,resources/static.md,resources/sleep.md,resourc…
…es/rotating.md,resources/offset.md,functions/rfc3339_parse.md,functions/duration_parse.md (#389)
- Loading branch information
1 parent
20415e2
commit 8814f00
Showing
2 changed files
with
116 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
page_title: "duration_parse function - terraform-provider-time" | ||
subcategory: "" | ||
description: |- | ||
Parse a Go duration string https://pkg.go.dev/time#ParseDuration into an object | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# function: duration_parse | ||
|
||
Given a [Go duration string](https://pkg.go.dev/time#ParseDuration), will parse and return an object representation of that duration. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Configuration using provider functions must include required_providers configuration. | ||
terraform { | ||
required_providers { | ||
time = { | ||
source = "hashicorp/time" | ||
# Setting the provider version is a strongly recommended practice | ||
# version = "..." | ||
} | ||
} | ||
# Provider functions require Terraform 1.8 and later. | ||
required_version = ">= 1.8.0" | ||
} | ||
output "example_output" { | ||
value = provider::time::duration_parse("1h") | ||
} | ||
``` | ||
|
||
## Signature | ||
|
||
<!-- signature generated by tfplugindocs --> | ||
```text | ||
duration_parse(duration string) object | ||
``` | ||
|
||
## Arguments | ||
|
||
<!-- arguments generated by tfplugindocs --> | ||
1. `duration` (String) Go time package duration string to parse | ||
|
||
|
||
## Return Type | ||
|
||
The `object` returned from `duration_parse` has the following attributes: | ||
- `hours` (Number) The duration as a floating point number of hours. | ||
- `minutes` (Number) The duration as a floating point number of minutes. | ||
- `seconds` (Number) The duration as a floating point number of seconds. | ||
- `milliseconds` (Number) The duration as an integer number of milliseconds. | ||
- `microseconds` (Number) The duration as an integer number of microseconds. | ||
- `nanoseconds` (Number) The duration as an integer number of nanoseconds. | ||
|
||
<!-- cache-key: cdktf-0.20.8 input-66898324acac2fb949e3bf64d2de78df844e2156cccb3c8e6df146c3383d2c9b --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
page_title: "duration_parse function - terraform-provider-time" | ||
subcategory: "" | ||
description: |- | ||
Parse a Go duration string https://pkg.go.dev/time#ParseDuration into an object | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# function: duration_parse | ||
|
||
Given a [Go duration string](https://pkg.go.dev/time#ParseDuration), will parse and return an object representation of that duration. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Configuration using provider functions must include required_providers configuration. | ||
terraform { | ||
required_providers { | ||
time = { | ||
source = "hashicorp/time" | ||
# Setting the provider version is a strongly recommended practice | ||
# version = "..." | ||
} | ||
} | ||
# Provider functions require Terraform 1.8 and later. | ||
required_version = ">= 1.8.0" | ||
} | ||
output "example_output" { | ||
value = provider::time::duration_parse("1h") | ||
} | ||
``` | ||
|
||
## Signature | ||
|
||
<!-- signature generated by tfplugindocs --> | ||
```text | ||
duration_parse(duration string) object | ||
``` | ||
|
||
## Arguments | ||
|
||
<!-- arguments generated by tfplugindocs --> | ||
1. `duration` (String) Go time package duration string to parse | ||
|
||
|
||
## Return Type | ||
|
||
The `object` returned from `duration_parse` has the following attributes: | ||
- `hours` (Number) The duration as a floating point number of hours. | ||
- `minutes` (Number) The duration as a floating point number of minutes. | ||
- `seconds` (Number) The duration as a floating point number of seconds. | ||
- `milliseconds` (Number) The duration as an integer number of milliseconds. | ||
- `microseconds` (Number) The duration as an integer number of microseconds. | ||
- `nanoseconds` (Number) The duration as an integer number of nanoseconds. | ||
|
||
<!-- cache-key: cdktf-0.20.8 input-66898324acac2fb949e3bf64d2de78df844e2156cccb3c8e6df146c3383d2c9b --> |