From a91716cc59558bd82e7599551dceaac96e421dca Mon Sep 17 00:00:00 2001 From: Ansgar Mertens Date: Wed, 19 Oct 2022 10:37:22 +0200 Subject: [PATCH 1/2] feat!: upgrade cdktf version --- .projen/deps.json | 6 +++--- .projen/tasks.json | 10 +++++----- .projenrc.js | 2 +- package.json | 6 +++--- yarn.lock | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.projen/deps.json b/.projen/deps.json index 6774b15..6685fdc 100644 --- a/.projen/deps.json +++ b/.projen/deps.json @@ -12,12 +12,12 @@ }, { "name": "cdktf-cli", - "version": ">=0.12.2 <0.14.0", + "version": "^0.13.0", "type": "build" }, { "name": "cdktf", - "version": ">=0.12.2 <0.14.0", + "version": "^0.13.0", "type": "build" }, { @@ -87,7 +87,7 @@ }, { "name": "cdktf", - "version": ">=0.12.2 <0.14.0", + "version": "^0.13.0", "type": "peer" }, { diff --git a/.projen/tasks.json b/.projen/tasks.json index 03ce70b..12faccf 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -292,19 +292,19 @@ "exec": "yarn upgrade npm-check-updates" }, { - "exec": "npm-check-updates --dep dev --upgrade --target=minor --reject='cdktf-cli,cdktf,node-fetch'" + "exec": "npm-check-updates --dep dev --upgrade --target=minor --reject='node-fetch'" }, { - "exec": "npm-check-updates --dep optional --upgrade --target=minor --reject='cdktf-cli,cdktf,node-fetch'" + "exec": "npm-check-updates --dep optional --upgrade --target=minor --reject='node-fetch'" }, { - "exec": "npm-check-updates --dep peer --upgrade --target=minor --reject='cdktf-cli,cdktf,node-fetch'" + "exec": "npm-check-updates --dep peer --upgrade --target=minor --reject='node-fetch'" }, { - "exec": "npm-check-updates --dep prod --upgrade --target=minor --reject='cdktf-cli,cdktf,node-fetch'" + "exec": "npm-check-updates --dep prod --upgrade --target=minor --reject='node-fetch'" }, { - "exec": "npm-check-updates --dep bundle --upgrade --target=minor --reject='cdktf-cli,cdktf,node-fetch'" + "exec": "npm-check-updates --dep bundle --upgrade --target=minor --reject='node-fetch'" }, { "exec": "yarn install --check-files" diff --git a/.projenrc.js b/.projenrc.js index fca1dab..7013a00 100644 --- a/.projenrc.js +++ b/.projenrc.js @@ -2,7 +2,7 @@ const { CdktfProviderProject } = require("@cdktf/provider-project"); const project = new CdktfProviderProject({ useCustomGithubRunner: false, terraformProvider: "hashicorp/time@~> 0.7", - cdktfVersion: ">=0.12.2 <0.14.0", + cdktfVersion: "^0.13.0", constructsVersion: "^10.0.0", minNodeVersion: "14.17.0", jsiiVersion: "^1.53.0", diff --git a/package.json b/package.json index 1199c6f..f724094 100644 --- a/package.json +++ b/package.json @@ -45,8 +45,8 @@ "devDependencies": { "@cdktf/provider-project": "^0.2.8", "@types/node": "^14", - "cdktf": ">=0.12.2 <0.14.0", - "cdktf-cli": ">=0.12.2 <0.14.0", + "cdktf": "^0.13.0", + "cdktf-cli": "^0.13.0", "constructs": "^10.0.0", "dot-prop": "^5.2.0", "jsii": "^1.53.0", @@ -60,7 +60,7 @@ "typescript": "^4.8.4" }, "peerDependencies": { - "cdktf": ">=0.12.2 <0.14.0", + "cdktf": "^0.13.0", "constructs": "^10.0.0" }, "keywords": [ diff --git a/yarn.lock b/yarn.lock index 3be67cf..dd0d7cd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -847,7 +847,7 @@ case@^1.6.3: resolved "https://registry.yarnpkg.com/case/-/case-1.6.3.tgz#0a4386e3e9825351ca2e6216c60467ff5f1ea1c9" integrity sha512-mzDSXIPaFwVDvZAHqZ9VlbyF4yyXRuX6IvB06WvPYkqJVO24kX1PPhv9bfpKNFZyxYFmmgo03HUiD8iklmJYRQ== -"cdktf-cli@>=0.12.2 <0.14.0": +cdktf-cli@^0.13.0: version "0.13.1" resolved "https://registry.yarnpkg.com/cdktf-cli/-/cdktf-cli-0.13.1.tgz#38f851d5fb58fe5eb920111286db62d53090126d" integrity sha512-p8R0FTuCxrOEHC6JB2v8zTlK5YNJQBCGdv9lr+760YkImN1YJ+f9gYicd/1Xr6ZYgUOS2ExWENf+9c7Mz1CsWA== @@ -872,7 +872,7 @@ case@^1.6.3: yargs "^17.5" yoga-layout-prebuilt "^1.10.0" -cdktf@0.13.1, "cdktf@>=0.12.2 <0.14.0": +cdktf@0.13.1, cdktf@^0.13.0: version "0.13.1" resolved "https://registry.yarnpkg.com/cdktf/-/cdktf-0.13.1.tgz#8337552bdf48c237b5dda6d1ec350cb8c336b773" integrity sha512-exCUk6mzamu0VLZrn3aDlbR2fejPTeyJtz5bssCwnwJN8gNRkiEw7LPWja6zPESNzFXHP0ccHMwpHiJYR7H5qA== From 32224c4a90fe30faf9dce81ea9968cbe65d93ed4 Mon Sep 17 00:00:00 2001 From: Ansgar Mertens Date: Wed, 19 Oct 2022 11:01:16 +0200 Subject: [PATCH 2/2] feat: upgrade provider bindings after upgrading cdktf version --- API.md | 1486 +++++++++---------- package.json | 2 +- src/index.ts | 10 +- src/offset/README.md | 3 + src/{offset.ts => offset/index.ts} | 2 +- src/provider/README.md | 3 + src/{time-provider.ts => provider/index.ts} | 2 +- src/rotating/README.md | 3 + src/{rotating.ts => rotating/index.ts} | 2 +- src/sleep/README.md | 3 + src/{sleep.ts => sleep/index.ts} | 2 +- src/static-resource/README.md | 3 + src/{static.ts => static-resource/index.ts} | 14 +- src/version.json | 2 +- 14 files changed, 776 insertions(+), 761 deletions(-) create mode 100644 src/offset/README.md rename src/{offset.ts => offset/index.ts} (99%) create mode 100644 src/provider/README.md rename src/{time-provider.ts => provider/index.ts} (98%) create mode 100644 src/rotating/README.md rename src/{rotating.ts => rotating/index.ts} (99%) create mode 100644 src/sleep/README.md rename src/{sleep.ts => sleep/index.ts} (99%) create mode 100644 src/static-resource/README.md rename src/{static.ts => static-resource/index.ts} (92%) diff --git a/API.md b/API.md index 17263ab..e30e621 100644 --- a/API.md +++ b/API.md @@ -2,27 +2,27 @@ ## Constructs -### Offset +### Offset Represents a {@link https://www.terraform.io/docs/providers/time/r/offset time_offset}. -#### Initializers +#### Initializers ```typescript -import { Offset } from '@cdktf/provider-time' +import { offset } from '@cdktf/provider-time' -new Offset(scope: Construct, id: string, config?: OffsetConfig) +new offset.Offset(scope: Construct, id: string, config?: OffsetConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | The scope in which to define this construct. | -| id | string | The scoped construct ID. | -| config | OffsetConfig | *No description.* | +| scope | constructs.Construct | The scope in which to define this construct. | +| id | string | The scoped construct ID. | +| config | @cdktf/provider-time.offset.OffsetConfig | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -30,7 +30,7 @@ The scope in which to define this construct. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -40,9 +40,9 @@ Must be unique amongst siblings in the same scope --- -##### `config`Optional +##### `config`Optional -- *Type:* OffsetConfig +- *Type:* @cdktf/provider-time.offset.OffsetConfig --- @@ -50,34 +50,34 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addOverride | *No description.* | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | -| toMetadata | *No description.* | -| toTerraform | Adds this resource to the terraform JSON output. | -| getAnyMapAttribute | *No description.* | -| getBooleanAttribute | *No description.* | -| getBooleanMapAttribute | *No description.* | -| getListAttribute | *No description.* | -| getNumberAttribute | *No description.* | -| getNumberListAttribute | *No description.* | -| getNumberMapAttribute | *No description.* | -| getStringAttribute | *No description.* | -| getStringMapAttribute | *No description.* | -| interpolationForAttribute | *No description.* | -| resetBaseRfc3339 | *No description.* | -| resetOffsetDays | *No description.* | -| resetOffsetHours | *No description.* | -| resetOffsetMinutes | *No description.* | -| resetOffsetMonths | *No description.* | -| resetOffsetSeconds | *No description.* | -| resetOffsetYears | *No description.* | -| resetTriggers | *No description.* | - ---- - -##### `toString` +| toString | Returns a string representation of this construct. | +| addOverride | *No description.* | +| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| getAnyMapAttribute | *No description.* | +| getBooleanAttribute | *No description.* | +| getBooleanMapAttribute | *No description.* | +| getListAttribute | *No description.* | +| getNumberAttribute | *No description.* | +| getNumberListAttribute | *No description.* | +| getNumberMapAttribute | *No description.* | +| getStringAttribute | *No description.* | +| getStringMapAttribute | *No description.* | +| interpolationForAttribute | *No description.* | +| resetBaseRfc3339 | *No description.* | +| resetOffsetDays | *No description.* | +| resetOffsetHours | *No description.* | +| resetOffsetMinutes | *No description.* | +| resetOffsetMonths | *No description.* | +| resetOffsetSeconds | *No description.* | +| resetOffsetYears | *No description.* | +| resetTriggers | *No description.* | + +--- + +##### `toString` ```typescript public toString(): string @@ -85,25 +85,25 @@ public toString(): string Returns a string representation of this construct. -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -111,7 +111,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -119,7 +119,7 @@ The new logical ID to use for this stack element. --- -##### `resetOverrideLogicalId` +##### `resetOverrideLogicalId` ```typescript public resetOverrideLogicalId(): void @@ -127,13 +127,13 @@ public resetOverrideLogicalId(): void Resets a previously passed logical Id to use the auto-generated logical id again. -##### `toMetadata` +##### `toMetadata` ```typescript public toMetadata(): any ``` -##### `toTerraform` +##### `toTerraform` ```typescript public toTerraform(): any @@ -141,169 +141,169 @@ public toTerraform(): any Adds this resource to the terraform JSON output. -##### `getAnyMapAttribute` +##### `getAnyMapAttribute` ```typescript public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanAttribute` +##### `getBooleanAttribute` ```typescript public getBooleanAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanMapAttribute` +##### `getBooleanMapAttribute` ```typescript public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getListAttribute` +##### `getListAttribute` ```typescript public getListAttribute(terraformAttribute: string): string[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberAttribute` +##### `getNumberAttribute` ```typescript public getNumberAttribute(terraformAttribute: string): number ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberListAttribute` +##### `getNumberListAttribute` ```typescript public getNumberListAttribute(terraformAttribute: string): number[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberMapAttribute` +##### `getNumberMapAttribute` ```typescript public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringAttribute` +##### `getStringAttribute` ```typescript public getStringAttribute(terraformAttribute: string): string ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringMapAttribute` +##### `getStringMapAttribute` ```typescript public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `interpolationForAttribute` +##### `interpolationForAttribute` ```typescript public interpolationForAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `resetBaseRfc3339` +##### `resetBaseRfc3339` ```typescript public resetBaseRfc3339(): void ``` -##### `resetOffsetDays` +##### `resetOffsetDays` ```typescript public resetOffsetDays(): void ``` -##### `resetOffsetHours` +##### `resetOffsetHours` ```typescript public resetOffsetHours(): void ``` -##### `resetOffsetMinutes` +##### `resetOffsetMinutes` ```typescript public resetOffsetMinutes(): void ``` -##### `resetOffsetMonths` +##### `resetOffsetMonths` ```typescript public resetOffsetMonths(): void ``` -##### `resetOffsetSeconds` +##### `resetOffsetSeconds` ```typescript public resetOffsetSeconds(): void ``` -##### `resetOffsetYears` +##### `resetOffsetYears` ```typescript public resetOffsetYears(): void ``` -##### `resetTriggers` +##### `resetTriggers` ```typescript public resetTriggers(): void @@ -313,16 +313,16 @@ public resetTriggers(): void | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Offset } from '@cdktf/provider-time' +import { offset } from '@cdktf/provider-time' -Offset.isConstruct(x: any) +offset.Offset.isConstruct(x: any) ``` Checks if `x` is a construct. @@ -341,7 +341,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -353,49 +353,49 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdktfStack | cdktf.TerraformStack | *No description.* | -| fqn | string | *No description.* | -| friendlyUniqueId | string | *No description.* | -| terraformMetaArguments | {[ key: string ]: any} | *No description.* | -| terraformResourceType | string | *No description.* | -| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | string[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| day | number | *No description.* | -| hour | number | *No description.* | -| id | string | *No description.* | -| minute | number | *No description.* | -| month | number | *No description.* | -| rfc3339 | string | *No description.* | -| second | number | *No description.* | -| unix | number | *No description.* | -| year | number | *No description.* | -| baseRfc3339Input | string | *No description.* | -| offsetDaysInput | number | *No description.* | -| offsetHoursInput | number | *No description.* | -| offsetMinutesInput | number | *No description.* | -| offsetMonthsInput | number | *No description.* | -| offsetSecondsInput | number | *No description.* | -| offsetYearsInput | number | *No description.* | -| triggersInput | {[ key: string ]: string} | *No description.* | -| baseRfc3339 | string | *No description.* | -| offsetDays | number | *No description.* | -| offsetHours | number | *No description.* | -| offsetMinutes | number | *No description.* | -| offsetMonths | number | *No description.* | -| offsetSeconds | number | *No description.* | -| offsetYears | number | *No description.* | -| triggers | {[ key: string ]: string} | *No description.* | - ---- - -##### `node`Required +| node | constructs.Node | The tree node. | +| cdktfStack | cdktf.TerraformStack | *No description.* | +| fqn | string | *No description.* | +| friendlyUniqueId | string | *No description.* | +| terraformMetaArguments | {[ key: string ]: any} | *No description.* | +| terraformResourceType | string | *No description.* | +| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | string[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| day | number | *No description.* | +| hour | number | *No description.* | +| id | string | *No description.* | +| minute | number | *No description.* | +| month | number | *No description.* | +| rfc3339 | string | *No description.* | +| second | number | *No description.* | +| unix | number | *No description.* | +| year | number | *No description.* | +| baseRfc3339Input | string | *No description.* | +| offsetDaysInput | number | *No description.* | +| offsetHoursInput | number | *No description.* | +| offsetMinutesInput | number | *No description.* | +| offsetMonthsInput | number | *No description.* | +| offsetSecondsInput | number | *No description.* | +| offsetYearsInput | number | *No description.* | +| triggersInput | {[ key: string ]: string} | *No description.* | +| baseRfc3339 | string | *No description.* | +| offsetDays | number | *No description.* | +| offsetHours | number | *No description.* | +| offsetMinutes | number | *No description.* | +| offsetMonths | number | *No description.* | +| offsetSeconds | number | *No description.* | +| offsetYears | number | *No description.* | +| triggers | {[ key: string ]: string} | *No description.* | + +--- + +##### `node`Required ```typescript public readonly node: Node; @@ -407,7 +407,7 @@ The tree node. --- -##### `cdktfStack`Required +##### `cdktfStack`Required ```typescript public readonly cdktfStack: TerraformStack; @@ -417,7 +417,7 @@ public readonly cdktfStack: TerraformStack; --- -##### `fqn`Required +##### `fqn`Required ```typescript public readonly fqn: string; @@ -427,7 +427,7 @@ public readonly fqn: string; --- -##### `friendlyUniqueId`Required +##### `friendlyUniqueId`Required ```typescript public readonly friendlyUniqueId: string; @@ -437,7 +437,7 @@ public readonly friendlyUniqueId: string; --- -##### `terraformMetaArguments`Required +##### `terraformMetaArguments`Required ```typescript public readonly terraformMetaArguments: {[ key: string ]: any}; @@ -447,7 +447,7 @@ public readonly terraformMetaArguments: {[ key: string ]: any}; --- -##### `terraformResourceType`Required +##### `terraformResourceType`Required ```typescript public readonly terraformResourceType: string; @@ -457,7 +457,7 @@ public readonly terraformResourceType: string; --- -##### `terraformGeneratorMetadata`Optional +##### `terraformGeneratorMetadata`Optional ```typescript public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; @@ -467,7 +467,7 @@ public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -477,7 +477,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -487,7 +487,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: string[]; @@ -497,7 +497,7 @@ public readonly dependsOn: string[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -507,7 +507,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -517,7 +517,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -527,7 +527,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -537,7 +537,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `day`Required +##### `day`Required ```typescript public readonly day: number; @@ -547,7 +547,7 @@ public readonly day: number; --- -##### `hour`Required +##### `hour`Required ```typescript public readonly hour: number; @@ -557,7 +557,7 @@ public readonly hour: number; --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -567,7 +567,7 @@ public readonly id: string; --- -##### `minute`Required +##### `minute`Required ```typescript public readonly minute: number; @@ -577,7 +577,7 @@ public readonly minute: number; --- -##### `month`Required +##### `month`Required ```typescript public readonly month: number; @@ -587,7 +587,7 @@ public readonly month: number; --- -##### `rfc3339`Required +##### `rfc3339`Required ```typescript public readonly rfc3339: string; @@ -597,7 +597,7 @@ public readonly rfc3339: string; --- -##### `second`Required +##### `second`Required ```typescript public readonly second: number; @@ -607,7 +607,7 @@ public readonly second: number; --- -##### `unix`Required +##### `unix`Required ```typescript public readonly unix: number; @@ -617,7 +617,7 @@ public readonly unix: number; --- -##### `year`Required +##### `year`Required ```typescript public readonly year: number; @@ -627,7 +627,7 @@ public readonly year: number; --- -##### `baseRfc3339Input`Optional +##### `baseRfc3339Input`Optional ```typescript public readonly baseRfc3339Input: string; @@ -637,7 +637,7 @@ public readonly baseRfc3339Input: string; --- -##### `offsetDaysInput`Optional +##### `offsetDaysInput`Optional ```typescript public readonly offsetDaysInput: number; @@ -647,7 +647,7 @@ public readonly offsetDaysInput: number; --- -##### `offsetHoursInput`Optional +##### `offsetHoursInput`Optional ```typescript public readonly offsetHoursInput: number; @@ -657,7 +657,7 @@ public readonly offsetHoursInput: number; --- -##### `offsetMinutesInput`Optional +##### `offsetMinutesInput`Optional ```typescript public readonly offsetMinutesInput: number; @@ -667,7 +667,7 @@ public readonly offsetMinutesInput: number; --- -##### `offsetMonthsInput`Optional +##### `offsetMonthsInput`Optional ```typescript public readonly offsetMonthsInput: number; @@ -677,7 +677,7 @@ public readonly offsetMonthsInput: number; --- -##### `offsetSecondsInput`Optional +##### `offsetSecondsInput`Optional ```typescript public readonly offsetSecondsInput: number; @@ -687,7 +687,7 @@ public readonly offsetSecondsInput: number; --- -##### `offsetYearsInput`Optional +##### `offsetYearsInput`Optional ```typescript public readonly offsetYearsInput: number; @@ -697,7 +697,7 @@ public readonly offsetYearsInput: number; --- -##### `triggersInput`Optional +##### `triggersInput`Optional ```typescript public readonly triggersInput: {[ key: string ]: string}; @@ -707,7 +707,7 @@ public readonly triggersInput: {[ key: string ]: string}; --- -##### `baseRfc3339`Required +##### `baseRfc3339`Required ```typescript public readonly baseRfc3339: string; @@ -717,7 +717,7 @@ public readonly baseRfc3339: string; --- -##### `offsetDays`Required +##### `offsetDays`Required ```typescript public readonly offsetDays: number; @@ -727,7 +727,7 @@ public readonly offsetDays: number; --- -##### `offsetHours`Required +##### `offsetHours`Required ```typescript public readonly offsetHours: number; @@ -737,7 +737,7 @@ public readonly offsetHours: number; --- -##### `offsetMinutes`Required +##### `offsetMinutes`Required ```typescript public readonly offsetMinutes: number; @@ -747,7 +747,7 @@ public readonly offsetMinutes: number; --- -##### `offsetMonths`Required +##### `offsetMonths`Required ```typescript public readonly offsetMonths: number; @@ -757,7 +757,7 @@ public readonly offsetMonths: number; --- -##### `offsetSeconds`Required +##### `offsetSeconds`Required ```typescript public readonly offsetSeconds: number; @@ -767,7 +767,7 @@ public readonly offsetSeconds: number; --- -##### `offsetYears`Required +##### `offsetYears`Required ```typescript public readonly offsetYears: number; @@ -777,7 +777,7 @@ public readonly offsetYears: number; --- -##### `triggers`Required +##### `triggers`Required ```typescript public readonly triggers: {[ key: string ]: string}; @@ -791,11 +791,11 @@ public readonly triggers: {[ key: string ]: string}; | **Name** | **Type** | **Description** | | --- | --- | --- | -| tfResourceType | string | *No description.* | +| tfResourceType | string | *No description.* | --- -##### `tfResourceType`Required +##### `tfResourceType`Required ```typescript public readonly tfResourceType: string; @@ -805,27 +805,27 @@ public readonly tfResourceType: string; --- -### Rotating +### Rotating Represents a {@link https://www.terraform.io/docs/providers/time/r/rotating time_rotating}. -#### Initializers +#### Initializers ```typescript -import { Rotating } from '@cdktf/provider-time' +import { rotating } from '@cdktf/provider-time' -new Rotating(scope: Construct, id: string, config?: RotatingConfig) +new rotating.Rotating(scope: Construct, id: string, config?: RotatingConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | The scope in which to define this construct. | -| id | string | The scoped construct ID. | -| config | RotatingConfig | *No description.* | +| scope | constructs.Construct | The scope in which to define this construct. | +| id | string | The scoped construct ID. | +| config | @cdktf/provider-time.rotating.RotatingConfig | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -833,7 +833,7 @@ The scope in which to define this construct. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -843,9 +843,9 @@ Must be unique amongst siblings in the same scope --- -##### `config`Optional +##### `config`Optional -- *Type:* RotatingConfig +- *Type:* @cdktf/provider-time.rotating.RotatingConfig --- @@ -853,34 +853,34 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addOverride | *No description.* | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | -| toMetadata | *No description.* | -| toTerraform | Adds this resource to the terraform JSON output. | -| getAnyMapAttribute | *No description.* | -| getBooleanAttribute | *No description.* | -| getBooleanMapAttribute | *No description.* | -| getListAttribute | *No description.* | -| getNumberAttribute | *No description.* | -| getNumberListAttribute | *No description.* | -| getNumberMapAttribute | *No description.* | -| getStringAttribute | *No description.* | -| getStringMapAttribute | *No description.* | -| interpolationForAttribute | *No description.* | -| resetRfc3339 | *No description.* | -| resetRotationDays | *No description.* | -| resetRotationHours | *No description.* | -| resetRotationMinutes | *No description.* | -| resetRotationMonths | *No description.* | -| resetRotationRfc3339 | *No description.* | -| resetRotationYears | *No description.* | -| resetTriggers | *No description.* | - ---- - -##### `toString` +| toString | Returns a string representation of this construct. | +| addOverride | *No description.* | +| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| getAnyMapAttribute | *No description.* | +| getBooleanAttribute | *No description.* | +| getBooleanMapAttribute | *No description.* | +| getListAttribute | *No description.* | +| getNumberAttribute | *No description.* | +| getNumberListAttribute | *No description.* | +| getNumberMapAttribute | *No description.* | +| getStringAttribute | *No description.* | +| getStringMapAttribute | *No description.* | +| interpolationForAttribute | *No description.* | +| resetRfc3339 | *No description.* | +| resetRotationDays | *No description.* | +| resetRotationHours | *No description.* | +| resetRotationMinutes | *No description.* | +| resetRotationMonths | *No description.* | +| resetRotationRfc3339 | *No description.* | +| resetRotationYears | *No description.* | +| resetTriggers | *No description.* | + +--- + +##### `toString` ```typescript public toString(): string @@ -888,25 +888,25 @@ public toString(): string Returns a string representation of this construct. -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -914,7 +914,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -922,7 +922,7 @@ The new logical ID to use for this stack element. --- -##### `resetOverrideLogicalId` +##### `resetOverrideLogicalId` ```typescript public resetOverrideLogicalId(): void @@ -930,13 +930,13 @@ public resetOverrideLogicalId(): void Resets a previously passed logical Id to use the auto-generated logical id again. -##### `toMetadata` +##### `toMetadata` ```typescript public toMetadata(): any ``` -##### `toTerraform` +##### `toTerraform` ```typescript public toTerraform(): any @@ -944,169 +944,169 @@ public toTerraform(): any Adds this resource to the terraform JSON output. -##### `getAnyMapAttribute` +##### `getAnyMapAttribute` ```typescript public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanAttribute` +##### `getBooleanAttribute` ```typescript public getBooleanAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanMapAttribute` +##### `getBooleanMapAttribute` ```typescript public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getListAttribute` +##### `getListAttribute` ```typescript public getListAttribute(terraformAttribute: string): string[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberAttribute` +##### `getNumberAttribute` ```typescript public getNumberAttribute(terraformAttribute: string): number ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberListAttribute` +##### `getNumberListAttribute` ```typescript public getNumberListAttribute(terraformAttribute: string): number[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberMapAttribute` +##### `getNumberMapAttribute` ```typescript public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringAttribute` +##### `getStringAttribute` ```typescript public getStringAttribute(terraformAttribute: string): string ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringMapAttribute` +##### `getStringMapAttribute` ```typescript public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `interpolationForAttribute` +##### `interpolationForAttribute` ```typescript public interpolationForAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `resetRfc3339` +##### `resetRfc3339` ```typescript public resetRfc3339(): void ``` -##### `resetRotationDays` +##### `resetRotationDays` ```typescript public resetRotationDays(): void ``` -##### `resetRotationHours` +##### `resetRotationHours` ```typescript public resetRotationHours(): void ``` -##### `resetRotationMinutes` +##### `resetRotationMinutes` ```typescript public resetRotationMinutes(): void ``` -##### `resetRotationMonths` +##### `resetRotationMonths` ```typescript public resetRotationMonths(): void ``` -##### `resetRotationRfc3339` +##### `resetRotationRfc3339` ```typescript public resetRotationRfc3339(): void ``` -##### `resetRotationYears` +##### `resetRotationYears` ```typescript public resetRotationYears(): void ``` -##### `resetTriggers` +##### `resetTriggers` ```typescript public resetTriggers(): void @@ -1116,16 +1116,16 @@ public resetTriggers(): void | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Rotating } from '@cdktf/provider-time' +import { rotating } from '@cdktf/provider-time' -Rotating.isConstruct(x: any) +rotating.Rotating.isConstruct(x: any) ``` Checks if `x` is a construct. @@ -1144,7 +1144,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -1156,48 +1156,48 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdktfStack | cdktf.TerraformStack | *No description.* | -| fqn | string | *No description.* | -| friendlyUniqueId | string | *No description.* | -| terraformMetaArguments | {[ key: string ]: any} | *No description.* | -| terraformResourceType | string | *No description.* | -| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | string[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| day | number | *No description.* | -| hour | number | *No description.* | -| id | string | *No description.* | -| minute | number | *No description.* | -| month | number | *No description.* | -| second | number | *No description.* | -| unix | number | *No description.* | -| year | number | *No description.* | -| rfc3339Input | string | *No description.* | -| rotationDaysInput | number | *No description.* | -| rotationHoursInput | number | *No description.* | -| rotationMinutesInput | number | *No description.* | -| rotationMonthsInput | number | *No description.* | -| rotationRfc3339Input | string | *No description.* | -| rotationYearsInput | number | *No description.* | -| triggersInput | {[ key: string ]: string} | *No description.* | -| rfc3339 | string | *No description.* | -| rotationDays | number | *No description.* | -| rotationHours | number | *No description.* | -| rotationMinutes | number | *No description.* | -| rotationMonths | number | *No description.* | -| rotationRfc3339 | string | *No description.* | -| rotationYears | number | *No description.* | -| triggers | {[ key: string ]: string} | *No description.* | - ---- - -##### `node`Required +| node | constructs.Node | The tree node. | +| cdktfStack | cdktf.TerraformStack | *No description.* | +| fqn | string | *No description.* | +| friendlyUniqueId | string | *No description.* | +| terraformMetaArguments | {[ key: string ]: any} | *No description.* | +| terraformResourceType | string | *No description.* | +| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | string[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| day | number | *No description.* | +| hour | number | *No description.* | +| id | string | *No description.* | +| minute | number | *No description.* | +| month | number | *No description.* | +| second | number | *No description.* | +| unix | number | *No description.* | +| year | number | *No description.* | +| rfc3339Input | string | *No description.* | +| rotationDaysInput | number | *No description.* | +| rotationHoursInput | number | *No description.* | +| rotationMinutesInput | number | *No description.* | +| rotationMonthsInput | number | *No description.* | +| rotationRfc3339Input | string | *No description.* | +| rotationYearsInput | number | *No description.* | +| triggersInput | {[ key: string ]: string} | *No description.* | +| rfc3339 | string | *No description.* | +| rotationDays | number | *No description.* | +| rotationHours | number | *No description.* | +| rotationMinutes | number | *No description.* | +| rotationMonths | number | *No description.* | +| rotationRfc3339 | string | *No description.* | +| rotationYears | number | *No description.* | +| triggers | {[ key: string ]: string} | *No description.* | + +--- + +##### `node`Required ```typescript public readonly node: Node; @@ -1209,7 +1209,7 @@ The tree node. --- -##### `cdktfStack`Required +##### `cdktfStack`Required ```typescript public readonly cdktfStack: TerraformStack; @@ -1219,7 +1219,7 @@ public readonly cdktfStack: TerraformStack; --- -##### `fqn`Required +##### `fqn`Required ```typescript public readonly fqn: string; @@ -1229,7 +1229,7 @@ public readonly fqn: string; --- -##### `friendlyUniqueId`Required +##### `friendlyUniqueId`Required ```typescript public readonly friendlyUniqueId: string; @@ -1239,7 +1239,7 @@ public readonly friendlyUniqueId: string; --- -##### `terraformMetaArguments`Required +##### `terraformMetaArguments`Required ```typescript public readonly terraformMetaArguments: {[ key: string ]: any}; @@ -1249,7 +1249,7 @@ public readonly terraformMetaArguments: {[ key: string ]: any}; --- -##### `terraformResourceType`Required +##### `terraformResourceType`Required ```typescript public readonly terraformResourceType: string; @@ -1259,7 +1259,7 @@ public readonly terraformResourceType: string; --- -##### `terraformGeneratorMetadata`Optional +##### `terraformGeneratorMetadata`Optional ```typescript public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; @@ -1269,7 +1269,7 @@ public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -1279,7 +1279,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -1289,7 +1289,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: string[]; @@ -1299,7 +1299,7 @@ public readonly dependsOn: string[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -1309,7 +1309,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -1319,7 +1319,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -1329,7 +1329,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -1339,7 +1339,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `day`Required +##### `day`Required ```typescript public readonly day: number; @@ -1349,7 +1349,7 @@ public readonly day: number; --- -##### `hour`Required +##### `hour`Required ```typescript public readonly hour: number; @@ -1359,7 +1359,7 @@ public readonly hour: number; --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -1369,7 +1369,7 @@ public readonly id: string; --- -##### `minute`Required +##### `minute`Required ```typescript public readonly minute: number; @@ -1379,7 +1379,7 @@ public readonly minute: number; --- -##### `month`Required +##### `month`Required ```typescript public readonly month: number; @@ -1389,7 +1389,7 @@ public readonly month: number; --- -##### `second`Required +##### `second`Required ```typescript public readonly second: number; @@ -1399,7 +1399,7 @@ public readonly second: number; --- -##### `unix`Required +##### `unix`Required ```typescript public readonly unix: number; @@ -1409,7 +1409,7 @@ public readonly unix: number; --- -##### `year`Required +##### `year`Required ```typescript public readonly year: number; @@ -1419,7 +1419,7 @@ public readonly year: number; --- -##### `rfc3339Input`Optional +##### `rfc3339Input`Optional ```typescript public readonly rfc3339Input: string; @@ -1429,7 +1429,7 @@ public readonly rfc3339Input: string; --- -##### `rotationDaysInput`Optional +##### `rotationDaysInput`Optional ```typescript public readonly rotationDaysInput: number; @@ -1439,7 +1439,7 @@ public readonly rotationDaysInput: number; --- -##### `rotationHoursInput`Optional +##### `rotationHoursInput`Optional ```typescript public readonly rotationHoursInput: number; @@ -1449,7 +1449,7 @@ public readonly rotationHoursInput: number; --- -##### `rotationMinutesInput`Optional +##### `rotationMinutesInput`Optional ```typescript public readonly rotationMinutesInput: number; @@ -1459,7 +1459,7 @@ public readonly rotationMinutesInput: number; --- -##### `rotationMonthsInput`Optional +##### `rotationMonthsInput`Optional ```typescript public readonly rotationMonthsInput: number; @@ -1469,7 +1469,7 @@ public readonly rotationMonthsInput: number; --- -##### `rotationRfc3339Input`Optional +##### `rotationRfc3339Input`Optional ```typescript public readonly rotationRfc3339Input: string; @@ -1479,7 +1479,7 @@ public readonly rotationRfc3339Input: string; --- -##### `rotationYearsInput`Optional +##### `rotationYearsInput`Optional ```typescript public readonly rotationYearsInput: number; @@ -1489,7 +1489,7 @@ public readonly rotationYearsInput: number; --- -##### `triggersInput`Optional +##### `triggersInput`Optional ```typescript public readonly triggersInput: {[ key: string ]: string}; @@ -1499,7 +1499,7 @@ public readonly triggersInput: {[ key: string ]: string}; --- -##### `rfc3339`Required +##### `rfc3339`Required ```typescript public readonly rfc3339: string; @@ -1509,7 +1509,7 @@ public readonly rfc3339: string; --- -##### `rotationDays`Required +##### `rotationDays`Required ```typescript public readonly rotationDays: number; @@ -1519,7 +1519,7 @@ public readonly rotationDays: number; --- -##### `rotationHours`Required +##### `rotationHours`Required ```typescript public readonly rotationHours: number; @@ -1529,7 +1529,7 @@ public readonly rotationHours: number; --- -##### `rotationMinutes`Required +##### `rotationMinutes`Required ```typescript public readonly rotationMinutes: number; @@ -1539,7 +1539,7 @@ public readonly rotationMinutes: number; --- -##### `rotationMonths`Required +##### `rotationMonths`Required ```typescript public readonly rotationMonths: number; @@ -1549,7 +1549,7 @@ public readonly rotationMonths: number; --- -##### `rotationRfc3339`Required +##### `rotationRfc3339`Required ```typescript public readonly rotationRfc3339: string; @@ -1559,7 +1559,7 @@ public readonly rotationRfc3339: string; --- -##### `rotationYears`Required +##### `rotationYears`Required ```typescript public readonly rotationYears: number; @@ -1569,7 +1569,7 @@ public readonly rotationYears: number; --- -##### `triggers`Required +##### `triggers`Required ```typescript public readonly triggers: {[ key: string ]: string}; @@ -1583,11 +1583,11 @@ public readonly triggers: {[ key: string ]: string}; | **Name** | **Type** | **Description** | | --- | --- | --- | -| tfResourceType | string | *No description.* | +| tfResourceType | string | *No description.* | --- -##### `tfResourceType`Required +##### `tfResourceType`Required ```typescript public readonly tfResourceType: string; @@ -1597,27 +1597,27 @@ public readonly tfResourceType: string; --- -### Sleep +### Sleep Represents a {@link https://www.terraform.io/docs/providers/time/r/sleep time_sleep}. -#### Initializers +#### Initializers ```typescript -import { Sleep } from '@cdktf/provider-time' +import { sleep } from '@cdktf/provider-time' -new Sleep(scope: Construct, id: string, config?: SleepConfig) +new sleep.Sleep(scope: Construct, id: string, config?: SleepConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | The scope in which to define this construct. | -| id | string | The scoped construct ID. | -| config | SleepConfig | *No description.* | +| scope | constructs.Construct | The scope in which to define this construct. | +| id | string | The scoped construct ID. | +| config | @cdktf/provider-time.sleep.SleepConfig | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -1625,7 +1625,7 @@ The scope in which to define this construct. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -1635,9 +1635,9 @@ Must be unique amongst siblings in the same scope --- -##### `config`Optional +##### `config`Optional -- *Type:* SleepConfig +- *Type:* @cdktf/provider-time.sleep.SleepConfig --- @@ -1645,29 +1645,29 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addOverride | *No description.* | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | -| toMetadata | *No description.* | -| toTerraform | Adds this resource to the terraform JSON output. | -| getAnyMapAttribute | *No description.* | -| getBooleanAttribute | *No description.* | -| getBooleanMapAttribute | *No description.* | -| getListAttribute | *No description.* | -| getNumberAttribute | *No description.* | -| getNumberListAttribute | *No description.* | -| getNumberMapAttribute | *No description.* | -| getStringAttribute | *No description.* | -| getStringMapAttribute | *No description.* | -| interpolationForAttribute | *No description.* | -| resetCreateDuration | *No description.* | -| resetDestroyDuration | *No description.* | -| resetTriggers | *No description.* | - ---- - -##### `toString` +| toString | Returns a string representation of this construct. | +| addOverride | *No description.* | +| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| getAnyMapAttribute | *No description.* | +| getBooleanAttribute | *No description.* | +| getBooleanMapAttribute | *No description.* | +| getListAttribute | *No description.* | +| getNumberAttribute | *No description.* | +| getNumberListAttribute | *No description.* | +| getNumberMapAttribute | *No description.* | +| getStringAttribute | *No description.* | +| getStringMapAttribute | *No description.* | +| interpolationForAttribute | *No description.* | +| resetCreateDuration | *No description.* | +| resetDestroyDuration | *No description.* | +| resetTriggers | *No description.* | + +--- + +##### `toString` ```typescript public toString(): string @@ -1675,25 +1675,25 @@ public toString(): string Returns a string representation of this construct. -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -1701,7 +1701,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -1709,7 +1709,7 @@ The new logical ID to use for this stack element. --- -##### `resetOverrideLogicalId` +##### `resetOverrideLogicalId` ```typescript public resetOverrideLogicalId(): void @@ -1717,13 +1717,13 @@ public resetOverrideLogicalId(): void Resets a previously passed logical Id to use the auto-generated logical id again. -##### `toMetadata` +##### `toMetadata` ```typescript public toMetadata(): any ``` -##### `toTerraform` +##### `toTerraform` ```typescript public toTerraform(): any @@ -1731,139 +1731,139 @@ public toTerraform(): any Adds this resource to the terraform JSON output. -##### `getAnyMapAttribute` +##### `getAnyMapAttribute` ```typescript public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanAttribute` +##### `getBooleanAttribute` ```typescript public getBooleanAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanMapAttribute` +##### `getBooleanMapAttribute` ```typescript public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getListAttribute` +##### `getListAttribute` ```typescript public getListAttribute(terraformAttribute: string): string[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberAttribute` +##### `getNumberAttribute` ```typescript public getNumberAttribute(terraformAttribute: string): number ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberListAttribute` +##### `getNumberListAttribute` ```typescript public getNumberListAttribute(terraformAttribute: string): number[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberMapAttribute` +##### `getNumberMapAttribute` ```typescript public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringAttribute` +##### `getStringAttribute` ```typescript public getStringAttribute(terraformAttribute: string): string ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringMapAttribute` +##### `getStringMapAttribute` ```typescript public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `interpolationForAttribute` +##### `interpolationForAttribute` ```typescript public interpolationForAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `resetCreateDuration` +##### `resetCreateDuration` ```typescript public resetCreateDuration(): void ``` -##### `resetDestroyDuration` +##### `resetDestroyDuration` ```typescript public resetDestroyDuration(): void ``` -##### `resetTriggers` +##### `resetTriggers` ```typescript public resetTriggers(): void @@ -1873,16 +1873,16 @@ public resetTriggers(): void | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Sleep } from '@cdktf/provider-time' +import { sleep } from '@cdktf/provider-time' -Sleep.isConstruct(x: any) +sleep.Sleep.isConstruct(x: any) ``` Checks if `x` is a construct. @@ -1901,7 +1901,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -1913,31 +1913,31 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdktfStack | cdktf.TerraformStack | *No description.* | -| fqn | string | *No description.* | -| friendlyUniqueId | string | *No description.* | -| terraformMetaArguments | {[ key: string ]: any} | *No description.* | -| terraformResourceType | string | *No description.* | -| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | string[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| id | string | *No description.* | -| createDurationInput | string | *No description.* | -| destroyDurationInput | string | *No description.* | -| triggersInput | {[ key: string ]: string} | *No description.* | -| createDuration | string | *No description.* | -| destroyDuration | string | *No description.* | -| triggers | {[ key: string ]: string} | *No description.* | - ---- - -##### `node`Required +| node | constructs.Node | The tree node. | +| cdktfStack | cdktf.TerraformStack | *No description.* | +| fqn | string | *No description.* | +| friendlyUniqueId | string | *No description.* | +| terraformMetaArguments | {[ key: string ]: any} | *No description.* | +| terraformResourceType | string | *No description.* | +| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | string[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| id | string | *No description.* | +| createDurationInput | string | *No description.* | +| destroyDurationInput | string | *No description.* | +| triggersInput | {[ key: string ]: string} | *No description.* | +| createDuration | string | *No description.* | +| destroyDuration | string | *No description.* | +| triggers | {[ key: string ]: string} | *No description.* | + +--- + +##### `node`Required ```typescript public readonly node: Node; @@ -1949,7 +1949,7 @@ The tree node. --- -##### `cdktfStack`Required +##### `cdktfStack`Required ```typescript public readonly cdktfStack: TerraformStack; @@ -1959,7 +1959,7 @@ public readonly cdktfStack: TerraformStack; --- -##### `fqn`Required +##### `fqn`Required ```typescript public readonly fqn: string; @@ -1969,7 +1969,7 @@ public readonly fqn: string; --- -##### `friendlyUniqueId`Required +##### `friendlyUniqueId`Required ```typescript public readonly friendlyUniqueId: string; @@ -1979,7 +1979,7 @@ public readonly friendlyUniqueId: string; --- -##### `terraformMetaArguments`Required +##### `terraformMetaArguments`Required ```typescript public readonly terraformMetaArguments: {[ key: string ]: any}; @@ -1989,7 +1989,7 @@ public readonly terraformMetaArguments: {[ key: string ]: any}; --- -##### `terraformResourceType`Required +##### `terraformResourceType`Required ```typescript public readonly terraformResourceType: string; @@ -1999,7 +1999,7 @@ public readonly terraformResourceType: string; --- -##### `terraformGeneratorMetadata`Optional +##### `terraformGeneratorMetadata`Optional ```typescript public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; @@ -2009,7 +2009,7 @@ public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -2019,7 +2019,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -2029,7 +2029,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: string[]; @@ -2039,7 +2039,7 @@ public readonly dependsOn: string[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -2049,7 +2049,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -2059,7 +2059,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -2069,7 +2069,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -2079,7 +2079,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -2089,7 +2089,7 @@ public readonly id: string; --- -##### `createDurationInput`Optional +##### `createDurationInput`Optional ```typescript public readonly createDurationInput: string; @@ -2099,7 +2099,7 @@ public readonly createDurationInput: string; --- -##### `destroyDurationInput`Optional +##### `destroyDurationInput`Optional ```typescript public readonly destroyDurationInput: string; @@ -2109,7 +2109,7 @@ public readonly destroyDurationInput: string; --- -##### `triggersInput`Optional +##### `triggersInput`Optional ```typescript public readonly triggersInput: {[ key: string ]: string}; @@ -2119,7 +2119,7 @@ public readonly triggersInput: {[ key: string ]: string}; --- -##### `createDuration`Required +##### `createDuration`Required ```typescript public readonly createDuration: string; @@ -2129,7 +2129,7 @@ public readonly createDuration: string; --- -##### `destroyDuration`Required +##### `destroyDuration`Required ```typescript public readonly destroyDuration: string; @@ -2139,7 +2139,7 @@ public readonly destroyDuration: string; --- -##### `triggers`Required +##### `triggers`Required ```typescript public readonly triggers: {[ key: string ]: string}; @@ -2153,11 +2153,11 @@ public readonly triggers: {[ key: string ]: string}; | **Name** | **Type** | **Description** | | --- | --- | --- | -| tfResourceType | string | *No description.* | +| tfResourceType | string | *No description.* | --- -##### `tfResourceType`Required +##### `tfResourceType`Required ```typescript public readonly tfResourceType: string; @@ -2167,27 +2167,27 @@ public readonly tfResourceType: string; --- -### Static +### StaticResource Represents a {@link https://www.terraform.io/docs/providers/time/r/static time_static}. -#### Initializers +#### Initializers ```typescript -import { Static } from '@cdktf/provider-time' +import { staticResource } from '@cdktf/provider-time' -new Static(scope: Construct, id: string, config?: StaticConfig) +new staticResource.StaticResource(scope: Construct, id: string, config?: StaticResourceConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | The scope in which to define this construct. | -| id | string | The scoped construct ID. | -| config | StaticConfig | *No description.* | +| scope | constructs.Construct | The scope in which to define this construct. | +| id | string | The scoped construct ID. | +| config | @cdktf/provider-time.staticResource.StaticResourceConfig | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -2195,7 +2195,7 @@ The scope in which to define this construct. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -2205,9 +2205,9 @@ Must be unique amongst siblings in the same scope --- -##### `config`Optional +##### `config`Optional -- *Type:* StaticConfig +- *Type:* @cdktf/provider-time.staticResource.StaticResourceConfig --- @@ -2215,28 +2215,28 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addOverride | *No description.* | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | -| toMetadata | *No description.* | -| toTerraform | Adds this resource to the terraform JSON output. | -| getAnyMapAttribute | *No description.* | -| getBooleanAttribute | *No description.* | -| getBooleanMapAttribute | *No description.* | -| getListAttribute | *No description.* | -| getNumberAttribute | *No description.* | -| getNumberListAttribute | *No description.* | -| getNumberMapAttribute | *No description.* | -| getStringAttribute | *No description.* | -| getStringMapAttribute | *No description.* | -| interpolationForAttribute | *No description.* | -| resetRfc3339 | *No description.* | -| resetTriggers | *No description.* | - ---- - -##### `toString` +| toString | Returns a string representation of this construct. | +| addOverride | *No description.* | +| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| getAnyMapAttribute | *No description.* | +| getBooleanAttribute | *No description.* | +| getBooleanMapAttribute | *No description.* | +| getListAttribute | *No description.* | +| getNumberAttribute | *No description.* | +| getNumberListAttribute | *No description.* | +| getNumberMapAttribute | *No description.* | +| getStringAttribute | *No description.* | +| getStringMapAttribute | *No description.* | +| interpolationForAttribute | *No description.* | +| resetRfc3339 | *No description.* | +| resetTriggers | *No description.* | + +--- + +##### `toString` ```typescript public toString(): string @@ -2244,25 +2244,25 @@ public toString(): string Returns a string representation of this construct. -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -2270,7 +2270,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -2278,7 +2278,7 @@ The new logical ID to use for this stack element. --- -##### `resetOverrideLogicalId` +##### `resetOverrideLogicalId` ```typescript public resetOverrideLogicalId(): void @@ -2286,13 +2286,13 @@ public resetOverrideLogicalId(): void Resets a previously passed logical Id to use the auto-generated logical id again. -##### `toMetadata` +##### `toMetadata` ```typescript public toMetadata(): any ``` -##### `toTerraform` +##### `toTerraform` ```typescript public toTerraform(): any @@ -2300,133 +2300,133 @@ public toTerraform(): any Adds this resource to the terraform JSON output. -##### `getAnyMapAttribute` +##### `getAnyMapAttribute` ```typescript public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanAttribute` +##### `getBooleanAttribute` ```typescript public getBooleanAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getBooleanMapAttribute` +##### `getBooleanMapAttribute` ```typescript public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getListAttribute` +##### `getListAttribute` ```typescript public getListAttribute(terraformAttribute: string): string[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberAttribute` +##### `getNumberAttribute` ```typescript public getNumberAttribute(terraformAttribute: string): number ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberListAttribute` +##### `getNumberListAttribute` ```typescript public getNumberListAttribute(terraformAttribute: string): number[] ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getNumberMapAttribute` +##### `getNumberMapAttribute` ```typescript public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringAttribute` +##### `getStringAttribute` ```typescript public getStringAttribute(terraformAttribute: string): string ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `getStringMapAttribute` +##### `getStringMapAttribute` ```typescript public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string} ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `interpolationForAttribute` +##### `interpolationForAttribute` ```typescript public interpolationForAttribute(terraformAttribute: string): IResolvable ``` -###### `terraformAttribute`Required +###### `terraformAttribute`Required - *Type:* string --- -##### `resetRfc3339` +##### `resetRfc3339` ```typescript public resetRfc3339(): void ``` -##### `resetTriggers` +##### `resetTriggers` ```typescript public resetTriggers(): void @@ -2436,16 +2436,16 @@ public resetTriggers(): void | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { Static } from '@cdktf/provider-time' +import { staticResource } from '@cdktf/provider-time' -Static.isConstruct(x: any) +staticResource.StaticResource.isConstruct(x: any) ``` Checks if `x` is a construct. @@ -2464,7 +2464,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -2476,36 +2476,36 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdktfStack | cdktf.TerraformStack | *No description.* | -| fqn | string | *No description.* | -| friendlyUniqueId | string | *No description.* | -| terraformMetaArguments | {[ key: string ]: any} | *No description.* | -| terraformResourceType | string | *No description.* | -| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | string[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| day | number | *No description.* | -| hour | number | *No description.* | -| id | string | *No description.* | -| minute | number | *No description.* | -| month | number | *No description.* | -| second | number | *No description.* | -| unix | number | *No description.* | -| year | number | *No description.* | -| rfc3339Input | string | *No description.* | -| triggersInput | {[ key: string ]: string} | *No description.* | -| rfc3339 | string | *No description.* | -| triggers | {[ key: string ]: string} | *No description.* | - ---- - -##### `node`Required +| node | constructs.Node | The tree node. | +| cdktfStack | cdktf.TerraformStack | *No description.* | +| fqn | string | *No description.* | +| friendlyUniqueId | string | *No description.* | +| terraformMetaArguments | {[ key: string ]: any} | *No description.* | +| terraformResourceType | string | *No description.* | +| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | string[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| day | number | *No description.* | +| hour | number | *No description.* | +| id | string | *No description.* | +| minute | number | *No description.* | +| month | number | *No description.* | +| second | number | *No description.* | +| unix | number | *No description.* | +| year | number | *No description.* | +| rfc3339Input | string | *No description.* | +| triggersInput | {[ key: string ]: string} | *No description.* | +| rfc3339 | string | *No description.* | +| triggers | {[ key: string ]: string} | *No description.* | + +--- + +##### `node`Required ```typescript public readonly node: Node; @@ -2517,7 +2517,7 @@ The tree node. --- -##### `cdktfStack`Required +##### `cdktfStack`Required ```typescript public readonly cdktfStack: TerraformStack; @@ -2527,7 +2527,7 @@ public readonly cdktfStack: TerraformStack; --- -##### `fqn`Required +##### `fqn`Required ```typescript public readonly fqn: string; @@ -2537,7 +2537,7 @@ public readonly fqn: string; --- -##### `friendlyUniqueId`Required +##### `friendlyUniqueId`Required ```typescript public readonly friendlyUniqueId: string; @@ -2547,7 +2547,7 @@ public readonly friendlyUniqueId: string; --- -##### `terraformMetaArguments`Required +##### `terraformMetaArguments`Required ```typescript public readonly terraformMetaArguments: {[ key: string ]: any}; @@ -2557,7 +2557,7 @@ public readonly terraformMetaArguments: {[ key: string ]: any}; --- -##### `terraformResourceType`Required +##### `terraformResourceType`Required ```typescript public readonly terraformResourceType: string; @@ -2567,7 +2567,7 @@ public readonly terraformResourceType: string; --- -##### `terraformGeneratorMetadata`Optional +##### `terraformGeneratorMetadata`Optional ```typescript public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; @@ -2577,7 +2577,7 @@ public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -2587,7 +2587,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -2597,7 +2597,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: string[]; @@ -2607,7 +2607,7 @@ public readonly dependsOn: string[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -2617,7 +2617,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -2627,7 +2627,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -2637,7 +2637,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -2647,7 +2647,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `day`Required +##### `day`Required ```typescript public readonly day: number; @@ -2657,7 +2657,7 @@ public readonly day: number; --- -##### `hour`Required +##### `hour`Required ```typescript public readonly hour: number; @@ -2667,7 +2667,7 @@ public readonly hour: number; --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -2677,7 +2677,7 @@ public readonly id: string; --- -##### `minute`Required +##### `minute`Required ```typescript public readonly minute: number; @@ -2687,7 +2687,7 @@ public readonly minute: number; --- -##### `month`Required +##### `month`Required ```typescript public readonly month: number; @@ -2697,7 +2697,7 @@ public readonly month: number; --- -##### `second`Required +##### `second`Required ```typescript public readonly second: number; @@ -2707,7 +2707,7 @@ public readonly second: number; --- -##### `unix`Required +##### `unix`Required ```typescript public readonly unix: number; @@ -2717,7 +2717,7 @@ public readonly unix: number; --- -##### `year`Required +##### `year`Required ```typescript public readonly year: number; @@ -2727,7 +2727,7 @@ public readonly year: number; --- -##### `rfc3339Input`Optional +##### `rfc3339Input`Optional ```typescript public readonly rfc3339Input: string; @@ -2737,7 +2737,7 @@ public readonly rfc3339Input: string; --- -##### `triggersInput`Optional +##### `triggersInput`Optional ```typescript public readonly triggersInput: {[ key: string ]: string}; @@ -2747,7 +2747,7 @@ public readonly triggersInput: {[ key: string ]: string}; --- -##### `rfc3339`Required +##### `rfc3339`Required ```typescript public readonly rfc3339: string; @@ -2757,7 +2757,7 @@ public readonly rfc3339: string; --- -##### `triggers`Required +##### `triggers`Required ```typescript public readonly triggers: {[ key: string ]: string}; @@ -2771,11 +2771,11 @@ public readonly triggers: {[ key: string ]: string}; | **Name** | **Type** | **Description** | | --- | --- | --- | -| tfResourceType | string | *No description.* | +| tfResourceType | string | *No description.* | --- -##### `tfResourceType`Required +##### `tfResourceType`Required ```typescript public readonly tfResourceType: string; @@ -2785,27 +2785,27 @@ public readonly tfResourceType: string; --- -### TimeProvider +### TimeProvider Represents a {@link https://www.terraform.io/docs/providers/time time}. -#### Initializers +#### Initializers ```typescript -import { TimeProvider } from '@cdktf/provider-time' +import { provider } from '@cdktf/provider-time' -new TimeProvider(scope: Construct, id: string, config?: TimeProviderConfig) +new provider.TimeProvider(scope: Construct, id: string, config?: TimeProviderConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | The scope in which to define this construct. | -| id | string | The scoped construct ID. | -| config | TimeProviderConfig | *No description.* | +| scope | constructs.Construct | The scope in which to define this construct. | +| id | string | The scoped construct ID. | +| config | @cdktf/provider-time.provider.TimeProviderConfig | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct @@ -2813,7 +2813,7 @@ The scope in which to define this construct. --- -##### `id`Required +##### `id`Required - *Type:* string @@ -2823,9 +2823,9 @@ Must be unique amongst siblings in the same scope --- -##### `config`Optional +##### `config`Optional -- *Type:* TimeProviderConfig +- *Type:* @cdktf/provider-time.provider.TimeProviderConfig --- @@ -2833,17 +2833,17 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addOverride | *No description.* | -| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | -| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | -| toMetadata | *No description.* | -| toTerraform | Adds this resource to the terraform JSON output. | -| resetAlias | *No description.* | +| toString | Returns a string representation of this construct. | +| addOverride | *No description.* | +| overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | +| resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | +| toMetadata | *No description.* | +| toTerraform | Adds this resource to the terraform JSON output. | +| resetAlias | *No description.* | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -2851,25 +2851,25 @@ public toString(): string Returns a string representation of this construct. -##### `addOverride` +##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `overrideLogicalId` +##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void @@ -2877,7 +2877,7 @@ public overrideLogicalId(newLogicalId: string): void Overrides the auto-generated logical ID with a specific ID. -###### `newLogicalId`Required +###### `newLogicalId`Required - *Type:* string @@ -2885,7 +2885,7 @@ The new logical ID to use for this stack element. --- -##### `resetOverrideLogicalId` +##### `resetOverrideLogicalId` ```typescript public resetOverrideLogicalId(): void @@ -2893,13 +2893,13 @@ public resetOverrideLogicalId(): void Resets a previously passed logical Id to use the auto-generated logical id again. -##### `toMetadata` +##### `toMetadata` ```typescript public toMetadata(): any ``` -##### `toTerraform` +##### `toTerraform` ```typescript public toTerraform(): any @@ -2907,7 +2907,7 @@ public toTerraform(): any Adds this resource to the terraform JSON output. -##### `resetAlias` +##### `resetAlias` ```typescript public resetAlias(): void @@ -2917,16 +2917,16 @@ public resetAlias(): void | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### `isConstruct` +##### `isConstruct` ```typescript -import { TimeProvider } from '@cdktf/provider-time' +import { provider } from '@cdktf/provider-time' -TimeProvider.isConstruct(x: any) +provider.TimeProvider.isConstruct(x: any) ``` Checks if `x` is a construct. @@ -2945,7 +2945,7 @@ library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. -###### `x`Required +###### `x`Required - *Type:* any @@ -2957,20 +2957,20 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdktfStack | cdktf.TerraformStack | *No description.* | -| fqn | string | *No description.* | -| friendlyUniqueId | string | *No description.* | -| metaAttributes | {[ key: string ]: any} | *No description.* | -| terraformResourceType | string | *No description.* | -| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | -| terraformProviderSource | string | *No description.* | -| alias | string | *No description.* | -| aliasInput | string | *No description.* | +| node | constructs.Node | The tree node. | +| cdktfStack | cdktf.TerraformStack | *No description.* | +| fqn | string | *No description.* | +| friendlyUniqueId | string | *No description.* | +| metaAttributes | {[ key: string ]: any} | *No description.* | +| terraformResourceType | string | *No description.* | +| terraformGeneratorMetadata | cdktf.TerraformProviderGeneratorMetadata | *No description.* | +| terraformProviderSource | string | *No description.* | +| alias | string | *No description.* | +| aliasInput | string | *No description.* | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -2982,7 +2982,7 @@ The tree node. --- -##### `cdktfStack`Required +##### `cdktfStack`Required ```typescript public readonly cdktfStack: TerraformStack; @@ -2992,7 +2992,7 @@ public readonly cdktfStack: TerraformStack; --- -##### `fqn`Required +##### `fqn`Required ```typescript public readonly fqn: string; @@ -3002,7 +3002,7 @@ public readonly fqn: string; --- -##### `friendlyUniqueId`Required +##### `friendlyUniqueId`Required ```typescript public readonly friendlyUniqueId: string; @@ -3012,7 +3012,7 @@ public readonly friendlyUniqueId: string; --- -##### `metaAttributes`Required +##### `metaAttributes`Required ```typescript public readonly metaAttributes: {[ key: string ]: any}; @@ -3022,7 +3022,7 @@ public readonly metaAttributes: {[ key: string ]: any}; --- -##### `terraformResourceType`Required +##### `terraformResourceType`Required ```typescript public readonly terraformResourceType: string; @@ -3032,7 +3032,7 @@ public readonly terraformResourceType: string; --- -##### `terraformGeneratorMetadata`Optional +##### `terraformGeneratorMetadata`Optional ```typescript public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; @@ -3042,7 +3042,7 @@ public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; --- -##### `terraformProviderSource`Optional +##### `terraformProviderSource`Optional ```typescript public readonly terraformProviderSource: string; @@ -3052,7 +3052,7 @@ public readonly terraformProviderSource: string; --- -##### `alias`Optional +##### `alias`Optional ```typescript public readonly alias: string; @@ -3062,7 +3062,7 @@ public readonly alias: string; --- -##### `aliasInput`Optional +##### `aliasInput`Optional ```typescript public readonly aliasInput: string; @@ -3076,11 +3076,11 @@ public readonly aliasInput: string; | **Name** | **Type** | **Description** | | --- | --- | --- | -| tfResourceType | string | *No description.* | +| tfResourceType | string | *No description.* | --- -##### `tfResourceType`Required +##### `tfResourceType`Required ```typescript public readonly tfResourceType: string; @@ -3092,39 +3092,39 @@ public readonly tfResourceType: string; ## Structs -### OffsetConfig +### OffsetConfig -#### Initializer +#### Initializer ```typescript -import { OffsetConfig } from '@cdktf/provider-time' +import { offset } from '@cdktf/provider-time' -const offsetConfig: OffsetConfig = { ... } +const offsetConfig: offset.OffsetConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | cdktf.ITerraformDependable[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| baseRfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | -| offsetDays | number | Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| offsetHours | number | Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| offsetMinutes | number | Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| offsetMonths | number | Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| offsetSeconds | number | Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| offsetYears | number | Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | -| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | cdktf.ITerraformDependable[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| baseRfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | +| offsetDays | number | Number of days to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| offsetHours | number | Number of hours to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| offsetMinutes | number | Number of minutes to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| offsetMonths | number | Number of months to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| offsetSeconds | number | Number of seconds to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| offsetYears | number | Number of years to offset the base timestamp. At least one of the 'offset_' arguments must be configured. | +| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -3134,7 +3134,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -3144,7 +3144,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: ITerraformDependable[]; @@ -3154,7 +3154,7 @@ public readonly dependsOn: ITerraformDependable[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -3164,7 +3164,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -3174,7 +3174,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -3184,7 +3184,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -3194,7 +3194,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `baseRfc3339`Optional +##### `baseRfc3339`Optional ```typescript public readonly baseRfc3339: string; @@ -3208,7 +3208,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetDays`Optional +##### `offsetDays`Optional ```typescript public readonly offsetDays: number; @@ -3222,7 +3222,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetHours`Optional +##### `offsetHours`Optional ```typescript public readonly offsetHours: number; @@ -3236,7 +3236,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetMinutes`Optional +##### `offsetMinutes`Optional ```typescript public readonly offsetMinutes: number; @@ -3250,7 +3250,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetMonths`Optional +##### `offsetMonths`Optional ```typescript public readonly offsetMonths: number; @@ -3264,7 +3264,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetSeconds`Optional +##### `offsetSeconds`Optional ```typescript public readonly offsetSeconds: number; @@ -3278,7 +3278,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `offsetYears`Optional +##### `offsetYears`Optional ```typescript public readonly offsetYears: number; @@ -3292,7 +3292,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `triggers`Optional +##### `triggers`Optional ```typescript public readonly triggers: {[ key: string ]: string}; @@ -3308,39 +3308,39 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -### RotatingConfig +### RotatingConfig -#### Initializer +#### Initializer ```typescript -import { RotatingConfig } from '@cdktf/provider-time' +import { rotating } from '@cdktf/provider-time' -const rotatingConfig: RotatingConfig = { ... } +const rotatingConfig: rotating.RotatingConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | cdktf.ITerraformDependable[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| rfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | -| rotationDays | number | Number of days to add to the base timestamp to configure the rotation timestamp. | -| rotationHours | number | Number of hours to add to the base timestamp to configure the rotation timestamp. | -| rotationMinutes | number | Number of minutes to add to the base timestamp to configure the rotation timestamp. | -| rotationMonths | number | Number of months to add to the base timestamp to configure the rotation timestamp. | -| rotationRfc3339 | string | Configure the rotation timestamp with an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format of the offset timestamp. When the current time has passed the rotation timestamp, the resource will trigger recreation. At least one of the 'rotation_' arguments must be configured. | -| rotationYears | number | Number of years to add to the base timestamp to configure the rotation timestamp. | -| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | cdktf.ITerraformDependable[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| rfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | +| rotationDays | number | Number of days to add to the base timestamp to configure the rotation timestamp. | +| rotationHours | number | Number of hours to add to the base timestamp to configure the rotation timestamp. | +| rotationMinutes | number | Number of minutes to add to the base timestamp to configure the rotation timestamp. | +| rotationMonths | number | Number of months to add to the base timestamp to configure the rotation timestamp. | +| rotationRfc3339 | string | Configure the rotation timestamp with an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format of the offset timestamp. When the current time has passed the rotation timestamp, the resource will trigger recreation. At least one of the 'rotation_' arguments must be configured. | +| rotationYears | number | Number of years to add to the base timestamp to configure the rotation timestamp. | +| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -3350,7 +3350,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -3360,7 +3360,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: ITerraformDependable[]; @@ -3370,7 +3370,7 @@ public readonly dependsOn: ITerraformDependable[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -3380,7 +3380,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -3390,7 +3390,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -3400,7 +3400,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -3410,7 +3410,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `rfc3339`Optional +##### `rfc3339`Optional ```typescript public readonly rfc3339: string; @@ -3424,7 +3424,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationDays`Optional +##### `rotationDays`Optional ```typescript public readonly rotationDays: number; @@ -3440,7 +3440,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationHours`Optional +##### `rotationHours`Optional ```typescript public readonly rotationHours: number; @@ -3456,7 +3456,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationMinutes`Optional +##### `rotationMinutes`Optional ```typescript public readonly rotationMinutes: number; @@ -3472,7 +3472,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationMonths`Optional +##### `rotationMonths`Optional ```typescript public readonly rotationMonths: number; @@ -3488,7 +3488,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationRfc3339`Optional +##### `rotationRfc3339`Optional ```typescript public readonly rotationRfc3339: string; @@ -3502,7 +3502,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `rotationYears`Optional +##### `rotationYears`Optional ```typescript public readonly rotationYears: number; @@ -3518,7 +3518,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `triggers`Optional +##### `triggers`Optional ```typescript public readonly triggers: {[ key: string ]: string}; @@ -3534,34 +3534,34 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -### SleepConfig +### SleepConfig -#### Initializer +#### Initializer ```typescript -import { SleepConfig } from '@cdktf/provider-time' +import { sleep } from '@cdktf/provider-time' -const sleepConfig: SleepConfig = { ... } +const sleepConfig: sleep.SleepConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | cdktf.ITerraformDependable[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| createDuration | string | [Time duration](https://golang.org/pkg/time/#ParseDuration) to delay resource creation. For example, `30s` for 30 seconds or `5m` for 5 minutes. Updating this value by itself will not trigger a delay. | -| destroyDuration | string | [Time duration](https://golang.org/pkg/time/#ParseDuration) to delay resource destroy. For example, `30s` for 30 seconds or `5m` for 5 minutes. Updating this value by itself will not trigger a delay. This value or any updates to it must be successfully applied into the Terraform state before destroying this resource to take effect. | -| triggers | {[ key: string ]: string} | (Optional) Arbitrary map of values that, when changed, will run any creation or destroy delays again. | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | cdktf.ITerraformDependable[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| createDuration | string | [Time duration](https://golang.org/pkg/time/#ParseDuration) to delay resource creation. For example, `30s` for 30 seconds or `5m` for 5 minutes. Updating this value by itself will not trigger a delay. | +| destroyDuration | string | [Time duration](https://golang.org/pkg/time/#ParseDuration) to delay resource destroy. For example, `30s` for 30 seconds or `5m` for 5 minutes. Updating this value by itself will not trigger a delay. This value or any updates to it must be successfully applied into the Terraform state before destroying this resource to take effect. | +| triggers | {[ key: string ]: string} | (Optional) Arbitrary map of values that, when changed, will run any creation or destroy delays again. | --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -3571,7 +3571,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -3581,7 +3581,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: ITerraformDependable[]; @@ -3591,7 +3591,7 @@ public readonly dependsOn: ITerraformDependable[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -3601,7 +3601,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -3611,7 +3611,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -3621,7 +3621,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -3631,7 +3631,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `createDuration`Optional +##### `createDuration`Optional ```typescript public readonly createDuration: string; @@ -3645,7 +3645,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `destroyDuration`Optional +##### `destroyDuration`Optional ```typescript public readonly destroyDuration: string; @@ -3659,7 +3659,7 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -##### `triggers`Optional +##### `triggers`Optional ```typescript public readonly triggers: {[ key: string ]: string}; @@ -3675,33 +3675,33 @@ Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/ --- -### StaticConfig +### StaticResourceConfig -#### Initializer +#### Initializer ```typescript -import { StaticConfig } from '@cdktf/provider-time' +import { staticResource } from '@cdktf/provider-time' -const staticConfig: StaticConfig = { ... } +const staticResourceConfig: staticResource.StaticResourceConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | -| count | number | *No description.* | -| dependsOn | cdktf.ITerraformDependable[] | *No description.* | -| forEach | cdktf.ITerraformIterator | *No description.* | -| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | -| provider | cdktf.TerraformProvider | *No description.* | -| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | -| rfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | -| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | +| connection | cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection | *No description.* | +| count | number | *No description.* | +| dependsOn | cdktf.ITerraformDependable[] | *No description.* | +| forEach | cdktf.ITerraformIterator | *No description.* | +| lifecycle | cdktf.TerraformResourceLifecycle | *No description.* | +| provider | cdktf.TerraformProvider | *No description.* | +| provisioners | cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[] | *No description.* | +| rfc3339 | string | Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. | +| triggers | {[ key: string ]: string} | Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. | --- -##### `connection`Optional +##### `connection`Optional ```typescript public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; @@ -3711,7 +3711,7 @@ public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnectio --- -##### `count`Optional +##### `count`Optional ```typescript public readonly count: number; @@ -3721,7 +3721,7 @@ public readonly count: number; --- -##### `dependsOn`Optional +##### `dependsOn`Optional ```typescript public readonly dependsOn: ITerraformDependable[]; @@ -3731,7 +3731,7 @@ public readonly dependsOn: ITerraformDependable[]; --- -##### `forEach`Optional +##### `forEach`Optional ```typescript public readonly forEach: ITerraformIterator; @@ -3741,7 +3741,7 @@ public readonly forEach: ITerraformIterator; --- -##### `lifecycle`Optional +##### `lifecycle`Optional ```typescript public readonly lifecycle: TerraformResourceLifecycle; @@ -3751,7 +3751,7 @@ public readonly lifecycle: TerraformResourceLifecycle; --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: TerraformProvider; @@ -3761,7 +3761,7 @@ public readonly provider: TerraformProvider; --- -##### `provisioners`Optional +##### `provisioners`Optional ```typescript public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]; @@ -3771,7 +3771,7 @@ public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExe --- -##### `rfc3339`Optional +##### `rfc3339`Optional ```typescript public readonly rfc3339: string; @@ -3781,11 +3781,11 @@ public readonly rfc3339: string; Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. -Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#rfc3339 Static#rfc3339} +Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#rfc3339 StaticResource#rfc3339} --- -##### `triggers`Optional +##### `triggers`Optional ```typescript public readonly triggers: {[ key: string ]: string}; @@ -3797,29 +3797,29 @@ Arbitrary map of values that, when changed, will trigger a new base timestamp va See [the main provider documentation](../index.md) for more information. -Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#triggers Static#triggers} +Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#triggers StaticResource#triggers} --- -### TimeProviderConfig +### TimeProviderConfig -#### Initializer +#### Initializer ```typescript -import { TimeProviderConfig } from '@cdktf/provider-time' +import { provider } from '@cdktf/provider-time' -const timeProviderConfig: TimeProviderConfig = { ... } +const timeProviderConfig: provider.TimeProviderConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | -| alias | string | Alias name. | +| alias | string | Alias name. | --- -##### `alias`Optional +##### `alias`Optional ```typescript public readonly alias: string; diff --git a/package.json b/package.json index f724094..ea2b131 100644 --- a/package.json +++ b/package.json @@ -112,7 +112,7 @@ "cdktf": { "provider": { "name": "registry.terraform.io/hashicorp/time", - "version": "0.8.0" + "version": "0.9.0" } }, "resolutions": { diff --git a/src/index.ts b/src/index.ts index f0ff0e8..a19c979 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,7 +1,7 @@ // generated by cdktf get -export * from './offset'; -export * from './rotating'; -export * from './sleep'; -export * from './static'; -export * from './time-provider'; +export * as offset from './offset'; +export * as rotating from './rotating'; +export * as sleep from './sleep'; +export * as staticResource from './static-resource'; +export * as provider from './provider'; diff --git a/src/offset/README.md b/src/offset/README.md new file mode 100644 index 0000000..c0f2069 --- /dev/null +++ b/src/offset/README.md @@ -0,0 +1,3 @@ +# `time_offset` + +Refer to the Terraform Registory for docs: [`time_offset`](https://www.terraform.io/docs/providers/time/r/offset). diff --git a/src/offset.ts b/src/offset/index.ts similarity index 99% rename from src/offset.ts rename to src/offset/index.ts index d89a76f..b3d1115 100644 --- a/src/offset.ts +++ b/src/offset/index.ts @@ -83,7 +83,7 @@ export class Offset extends cdktf.TerraformResource { terraformResourceType: 'time_offset', terraformGeneratorMetadata: { providerName: 'time', - providerVersion: '0.8.0', + providerVersion: '0.9.0', providerVersionConstraint: '~> 0.7' }, provider: config.provider, diff --git a/src/provider/README.md b/src/provider/README.md new file mode 100644 index 0000000..9ce6234 --- /dev/null +++ b/src/provider/README.md @@ -0,0 +1,3 @@ +# `provider` + +Refer to the Terraform Registory for docs: [`time`](https://www.terraform.io/docs/providers/time). diff --git a/src/time-provider.ts b/src/provider/index.ts similarity index 98% rename from src/time-provider.ts rename to src/provider/index.ts index 1227813..fb893d2 100644 --- a/src/time-provider.ts +++ b/src/provider/index.ts @@ -41,7 +41,7 @@ export class TimeProvider extends cdktf.TerraformProvider { terraformResourceType: 'time', terraformGeneratorMetadata: { providerName: 'time', - providerVersion: '0.8.0', + providerVersion: '0.9.0', providerVersionConstraint: '~> 0.7' }, terraformProviderSource: 'hashicorp/time' diff --git a/src/rotating/README.md b/src/rotating/README.md new file mode 100644 index 0000000..37de3c7 --- /dev/null +++ b/src/rotating/README.md @@ -0,0 +1,3 @@ +# `time_rotating` + +Refer to the Terraform Registory for docs: [`time_rotating`](https://www.terraform.io/docs/providers/time/r/rotating). diff --git a/src/rotating.ts b/src/rotating/index.ts similarity index 99% rename from src/rotating.ts rename to src/rotating/index.ts index 22d80e2..2083c26 100644 --- a/src/rotating.ts +++ b/src/rotating/index.ts @@ -83,7 +83,7 @@ export class Rotating extends cdktf.TerraformResource { terraformResourceType: 'time_rotating', terraformGeneratorMetadata: { providerName: 'time', - providerVersion: '0.8.0', + providerVersion: '0.9.0', providerVersionConstraint: '~> 0.7' }, provider: config.provider, diff --git a/src/sleep/README.md b/src/sleep/README.md new file mode 100644 index 0000000..d31fc57 --- /dev/null +++ b/src/sleep/README.md @@ -0,0 +1,3 @@ +# `time_sleep` + +Refer to the Terraform Registory for docs: [`time_sleep`](https://www.terraform.io/docs/providers/time/r/sleep). diff --git a/src/sleep.ts b/src/sleep/index.ts similarity index 99% rename from src/sleep.ts rename to src/sleep/index.ts index cb04324..ef4a4b4 100644 --- a/src/sleep.ts +++ b/src/sleep/index.ts @@ -53,7 +53,7 @@ export class Sleep extends cdktf.TerraformResource { terraformResourceType: 'time_sleep', terraformGeneratorMetadata: { providerName: 'time', - providerVersion: '0.8.0', + providerVersion: '0.9.0', providerVersionConstraint: '~> 0.7' }, provider: config.provider, diff --git a/src/static-resource/README.md b/src/static-resource/README.md new file mode 100644 index 0000000..2c2c849 --- /dev/null +++ b/src/static-resource/README.md @@ -0,0 +1,3 @@ +# `time_static` + +Refer to the Terraform Registory for docs: [`time_static`](https://www.terraform.io/docs/providers/time/r/static). diff --git a/src/static.ts b/src/static-resource/index.ts similarity index 92% rename from src/static.ts rename to src/static-resource/index.ts index 7fdb036..d9ac987 100644 --- a/src/static.ts +++ b/src/static-resource/index.ts @@ -6,17 +6,17 @@ import * as cdktf from 'cdktf'; // Configuration -export interface StaticConfig extends cdktf.TerraformMetaArguments { +export interface StaticResourceConfig extends cdktf.TerraformMetaArguments { /** * Base timestamp in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (see [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) e.g., `YYYY-MM-DDTHH:MM:SSZ`). Defaults to the current time. * - * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#rfc3339 Static#rfc3339} + * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#rfc3339 StaticResource#rfc3339} */ readonly rfc3339?: string; /** * Arbitrary map of values that, when changed, will trigger a new base timestamp value to be saved. See [the main provider documentation](../index.md) for more information. * - * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#triggers Static#triggers} + * Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/time/r/static#triggers StaticResource#triggers} */ readonly triggers?: { [key: string]: string }; } @@ -24,7 +24,7 @@ export interface StaticConfig extends cdktf.TerraformMetaArguments { /** * Represents a {@link https://www.terraform.io/docs/providers/time/r/static time_static} */ -export class Static extends cdktf.TerraformResource { +export class StaticResource extends cdktf.TerraformResource { // ================= // STATIC PROPERTIES @@ -40,14 +40,14 @@ export class Static extends cdktf.TerraformResource { * * @param scope The scope in which to define this construct * @param id The scoped construct ID. Must be unique amongst siblings in the same scope - * @param options StaticConfig = {} + * @param options StaticResourceConfig = {} */ - public constructor(scope: Construct, id: string, config: StaticConfig = {}) { + public constructor(scope: Construct, id: string, config: StaticResourceConfig = {}) { super(scope, id, { terraformResourceType: 'time_static', terraformGeneratorMetadata: { providerName: 'time', - providerVersion: '0.8.0', + providerVersion: '0.9.0', providerVersionConstraint: '~> 0.7' }, provider: config.provider, diff --git a/src/version.json b/src/version.json index 5d0cfad..85d9b5a 100644 --- a/src/version.json +++ b/src/version.json @@ -1,3 +1,3 @@ { - "registry.terraform.io/hashicorp/time": "0.8.0" + "registry.terraform.io/hashicorp/time": "0.9.0" }