mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-25 10:00:44 -05:00
migrate docs to mdx
This commit is contained in:
35
website/docs/language/functions/timeadd.mdx
Normal file
35
website/docs/language/functions/timeadd.mdx
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
page_title: timeadd - Functions - Configuration Language
|
||||
description: |-
|
||||
The timeadd function adds a duration to a timestamp, returning a new
|
||||
timestamp.
|
||||
sidebar_title: timeadd
|
||||
---
|
||||
|
||||
# `timeadd` Function
|
||||
|
||||
`timeadd` adds a duration to a timestamp, returning a new timestamp.
|
||||
|
||||
```hcl
|
||||
timeadd(timestamp, duration)
|
||||
```
|
||||
|
||||
In the Terraform language, timestamps are conventionally represented as
|
||||
strings using [RFC 3339](https://tools.ietf.org/html/rfc3339)
|
||||
"Date and Time format" syntax. `timeadd` requires the `timestamp` argument
|
||||
to be a string conforming to this syntax.
|
||||
|
||||
`duration` is a string representation of a time difference, consisting of
|
||||
sequences of number and unit pairs, like `"1.5h"` or `"1h30m"`. The accepted
|
||||
units are `"ns"`, `"us"` (or `"µs"`), `"ms"`, `"s"`, `"m"`, and `"h"`. The first
|
||||
number may be negative to indicate a negative duration, like `"-2h5m"`.
|
||||
|
||||
The result is a string, also in RFC 3339 format, representing the result
|
||||
of adding the given direction to the given timestamp.
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
> timeadd("2017-11-22T00:00:00Z", "10m")
|
||||
2017-11-22T00:10:00Z
|
||||
```
|
||||
Reference in New Issue
Block a user