Skip to content

Commit

Permalink
cdktf: update index.md,resources/static.md,resources/sleep.md,resourc…
Browse files Browse the repository at this point in the history
…es/rotating.md,resources/offset.md,functions/rfc3339_parse.md (#302)
  • Loading branch information
team-tf-cdk authored Mar 18, 2024
1 parent b7194a9 commit 0e9ba54
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/cdktf/python/functions/rfc3339_parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
page_title: "rfc3339_parse function - terraform-provider-time"
subcategory: ""
description: |-
Parse an RFC3339 timestamp string into an object
---


<!-- Please do not edit this file, it is generated. -->
# function: rfc3339_parse

Given an RFC3339 timestamp string, will parse and return an object representation of that date and time.

## 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::rfc3339_parse("2023-07-25T23:43:16Z")
}
```

## Signature

<!-- signature generated by tfplugindocs -->
```text
rfc3339_parse(timestamp string) object
```

## Arguments

<!-- arguments generated by tfplugindocs -->
1. `timestamp` (String) RFC3339 timestamp string to parse


## Return Type

The `object` returned from `rfc3339_parse` has the following attributes:
- `year` (Number) The year for the timestamp.
- `year_day` (Number) The day of the year for the timestamp, in the range [1, 365] for non-leap years, and [1, 366] in leap years.
- `day` (Number) The day of the month for the timestamp.
- `month` (Number) The month of the year for the timestamp.
- `month_name` (String) The name of the month for the timestamp (ex. "January").
- `weekday` (Number) The day of the week for the timestamp.
- `weekday_name` (String) The name of the day for the timestamp (ex. "Sunday").
- `hour` (Number) The hour within the day for the timestamp, in the range [0, 23].
- `minute` (Number) The minute offset within the hour for the timestamp, in the range [0, 59].
- `second` (Number) The second offset within the minute for the timestamp, in the range [0, 59].
- `unix` (Number) The number of seconds elapsed since January 1, 1970 UTC.
- `iso_year` (Number) The ISO 8601 year number.
- `iso_week` (Number) The ISO 8601 week number.

<!-- cache-key: cdktf-0.20.1 input-c0cbdf1a4147e46f0fd7cc28b8d72a3b7d631614190155bc0a571ec980b4f8b0 -->
65 changes: 65 additions & 0 deletions docs/cdktf/typescript/functions/rfc3339_parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
page_title: "rfc3339_parse function - terraform-provider-time"
subcategory: ""
description: |-
Parse an RFC3339 timestamp string into an object
---


<!-- Please do not edit this file, it is generated. -->
# function: rfc3339_parse

Given an RFC3339 timestamp string, will parse and return an object representation of that date and time.

## 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::rfc3339_parse("2023-07-25T23:43:16Z")
}
```

## Signature

<!-- signature generated by tfplugindocs -->
```text
rfc3339_parse(timestamp string) object
```

## Arguments

<!-- arguments generated by tfplugindocs -->
1. `timestamp` (String) RFC3339 timestamp string to parse


## Return Type

The `object` returned from `rfc3339_parse` has the following attributes:
- `year` (Number) The year for the timestamp.
- `year_day` (Number) The day of the year for the timestamp, in the range [1, 365] for non-leap years, and [1, 366] in leap years.
- `day` (Number) The day of the month for the timestamp.
- `month` (Number) The month of the year for the timestamp.
- `month_name` (String) The name of the month for the timestamp (ex. "January").
- `weekday` (Number) The day of the week for the timestamp.
- `weekday_name` (String) The name of the day for the timestamp (ex. "Sunday").
- `hour` (Number) The hour within the day for the timestamp, in the range [0, 23].
- `minute` (Number) The minute offset within the hour for the timestamp, in the range [0, 59].
- `second` (Number) The second offset within the minute for the timestamp, in the range [0, 59].
- `unix` (Number) The number of seconds elapsed since January 1, 1970 UTC.
- `iso_year` (Number) The ISO 8601 year number.
- `iso_week` (Number) The ISO 8601 week number.

<!-- cache-key: cdktf-0.20.1 input-c0cbdf1a4147e46f0fd7cc28b8d72a3b7d631614190155bc0a571ec980b4f8b0 -->

0 comments on commit 0e9ba54

Please sign in to comment.