@cdktf/provider-acme 6.0.0 → 6.0.2

package/docs/provider.typescript.md

@@ -1,414 +0,0 @@
-# `provider`
-
-Refer to the Terraform Registory for docs: [`acme`](https://registry.terraform.io/providers/vancluever/acme/2.13.1/docs).
-
-# `provider` Submodule <a name="`provider` Submodule" id="@cdktf/provider-acme.provider"></a>
-
-## Constructs <a name="Constructs" id="Constructs"></a>
-
-### AcmeProvider <a name="AcmeProvider" id="@cdktf/provider-acme.provider.AcmeProvider"></a>
-
-Represents a {@link https://registry.terraform.io/providers/vancluever/acme/2.13.1/docs acme}.
-
-#### Initializers <a name="Initializers" id="@cdktf/provider-acme.provider.AcmeProvider.Initializer"></a>
-
-```typescript
-import { provider } from '@cdktf/provider-acme'
-
-new provider.AcmeProvider(scope: Construct, id: string, config: AcmeProviderConfig)
-```
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | The scope in which to define this construct. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.id">id</a></code> | <code>string</code> | The scoped construct ID. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.config">config</a></code> | <code><a href="#@cdktf/provider-acme.provider.AcmeProviderConfig">AcmeProviderConfig</a></code> | *No description.* |
-
----
-
-##### `scope`<sup>Required</sup> <a name="scope" id="@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.scope"></a>
-
-- *Type:* constructs.Construct
-
-The scope in which to define this construct.
-
----
-
-##### `id`<sup>Required</sup> <a name="id" id="@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.id"></a>
-
-- *Type:* string
-
-The scoped construct ID.
-
-Must be unique amongst siblings in the same scope
-
----
-
-##### `config`<sup>Required</sup> <a name="config" id="@cdktf/provider-acme.provider.AcmeProvider.Initializer.parameter.config"></a>
-
-- *Type:* <a href="#@cdktf/provider-acme.provider.AcmeProviderConfig">AcmeProviderConfig</a>
-
----
-
-#### Methods <a name="Methods" id="Methods"></a>
-
-| **Name** | **Description** |
-| --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.toString">toString</a></code> | Returns a string representation of this construct. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.addOverride">addOverride</a></code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.overrideLogicalId">overrideLogicalId</a></code> | Overrides the auto-generated logical ID with a specific ID. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.resetOverrideLogicalId">resetOverrideLogicalId</a></code> | Resets a previously passed logical Id to use the auto-generated logical id again. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.toMetadata">toMetadata</a></code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.toTerraform">toTerraform</a></code> | Adds this resource to the terraform JSON output. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.resetAlias">resetAlias</a></code> | *No description.* |
-
----
-
-##### `toString` <a name="toString" id="@cdktf/provider-acme.provider.AcmeProvider.toString"></a>
-
-```typescript
-public toString(): string
-```
-
-Returns a string representation of this construct.
-
-##### `addOverride` <a name="addOverride" id="@cdktf/provider-acme.provider.AcmeProvider.addOverride"></a>
-
-```typescript
-public addOverride(path: string, value: any): void
-```
-
-###### `path`<sup>Required</sup> <a name="path" id="@cdktf/provider-acme.provider.AcmeProvider.addOverride.parameter.path"></a>
-
-- *Type:* string
-
----
-
-###### `value`<sup>Required</sup> <a name="value" id="@cdktf/provider-acme.provider.AcmeProvider.addOverride.parameter.value"></a>
-
-- *Type:* any
-
----
-
-##### `overrideLogicalId` <a name="overrideLogicalId" id="@cdktf/provider-acme.provider.AcmeProvider.overrideLogicalId"></a>
-
-```typescript
-public overrideLogicalId(newLogicalId: string): void
-```
-
-Overrides the auto-generated logical ID with a specific ID.
-
-###### `newLogicalId`<sup>Required</sup> <a name="newLogicalId" id="@cdktf/provider-acme.provider.AcmeProvider.overrideLogicalId.parameter.newLogicalId"></a>
-
-- *Type:* string
-
-The new logical ID to use for this stack element.
-
----
-
-##### `resetOverrideLogicalId` <a name="resetOverrideLogicalId" id="@cdktf/provider-acme.provider.AcmeProvider.resetOverrideLogicalId"></a>
-
-```typescript
-public resetOverrideLogicalId(): void
-```
-
-Resets a previously passed logical Id to use the auto-generated logical id again.
-
-##### `toMetadata` <a name="toMetadata" id="@cdktf/provider-acme.provider.AcmeProvider.toMetadata"></a>
-
-```typescript
-public toMetadata(): any
-```
-
-##### `toTerraform` <a name="toTerraform" id="@cdktf/provider-acme.provider.AcmeProvider.toTerraform"></a>
-
-```typescript
-public toTerraform(): any
-```
-
-Adds this resource to the terraform JSON output.
-
-##### `resetAlias` <a name="resetAlias" id="@cdktf/provider-acme.provider.AcmeProvider.resetAlias"></a>
-
-```typescript
-public resetAlias(): void
-```
-
-#### Static Functions <a name="Static Functions" id="Static Functions"></a>
-
-| **Name** | **Description** |
-| --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.isTerraformElement">isTerraformElement</a></code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.isTerraformProvider">isTerraformProvider</a></code> | *No description.* |
-
----
-
-##### `isConstruct` <a name="isConstruct" id="@cdktf/provider-acme.provider.AcmeProvider.isConstruct"></a>
-
-```typescript
-import { provider } from '@cdktf/provider-acme'
-
-provider.AcmeProvider.isConstruct(x: any)
-```
-
-Checks if `x` is a construct.
-
-Use this method instead of `instanceof` to properly detect `Construct`
-instances, even when the construct library is symlinked.
-
-Explanation: in JavaScript, multiple copies of the `constructs` library on
-disk are seen as independent, completely different libraries. As a
-consequence, the class `Construct` in each copy of the `constructs` library
-is seen as a different class, and an instance of one class will not test as
-`instanceof` the other class. `npm install` will not create installations
-like this, but users may manually symlink construct libraries together or
-use a monorepo tool: in those cases, multiple copies of the `constructs`
-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`<sup>Required</sup> <a name="x" id="@cdktf/provider-acme.provider.AcmeProvider.isConstruct.parameter.x"></a>
-
-- *Type:* any
-
-Any object.
-
----
-
-##### `isTerraformElement` <a name="isTerraformElement" id="@cdktf/provider-acme.provider.AcmeProvider.isTerraformElement"></a>
-
-```typescript
-import { provider } from '@cdktf/provider-acme'
-
-provider.AcmeProvider.isTerraformElement(x: any)
-```
-
-###### `x`<sup>Required</sup> <a name="x" id="@cdktf/provider-acme.provider.AcmeProvider.isTerraformElement.parameter.x"></a>
-
-- *Type:* any
-
----
-
-##### `isTerraformProvider` <a name="isTerraformProvider" id="@cdktf/provider-acme.provider.AcmeProvider.isTerraformProvider"></a>
-
-```typescript
-import { provider } from '@cdktf/provider-acme'
-
-provider.AcmeProvider.isTerraformProvider(x: any)
-```
-
-###### `x`<sup>Required</sup> <a name="x" id="@cdktf/provider-acme.provider.AcmeProvider.isTerraformProvider.parameter.x"></a>
-
-- *Type:* any
-
----
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.cdktfStack">cdktfStack</a></code> | <code>cdktf.TerraformStack</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.fqn">fqn</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.friendlyUniqueId">friendlyUniqueId</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.metaAttributes">metaAttributes</a></code> | <code>{[ key: string ]: any}</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.terraformResourceType">terraformResourceType</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.terraformGeneratorMetadata">terraformGeneratorMetadata</a></code> | <code>cdktf.TerraformProviderGeneratorMetadata</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.terraformProviderSource">terraformProviderSource</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.alias">alias</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.aliasInput">aliasInput</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.serverUrlInput">serverUrlInput</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.serverUrl">serverUrl</a></code> | <code>string</code> | *No description.* |
-
----
-
-##### `node`<sup>Required</sup> <a name="node" id="@cdktf/provider-acme.provider.AcmeProvider.property.node"></a>
-
-```typescript
-public readonly node: Node;
-```
-
-- *Type:* constructs.Node
-
-The tree node.
-
----
-
-##### `cdktfStack`<sup>Required</sup> <a name="cdktfStack" id="@cdktf/provider-acme.provider.AcmeProvider.property.cdktfStack"></a>
-
-```typescript
-public readonly cdktfStack: TerraformStack;
-```
-
-- *Type:* cdktf.TerraformStack
-
----
-
-##### `fqn`<sup>Required</sup> <a name="fqn" id="@cdktf/provider-acme.provider.AcmeProvider.property.fqn"></a>
-
-```typescript
-public readonly fqn: string;
-```
-
-- *Type:* string
-
----
-
-##### `friendlyUniqueId`<sup>Required</sup> <a name="friendlyUniqueId" id="@cdktf/provider-acme.provider.AcmeProvider.property.friendlyUniqueId"></a>
-
-```typescript
-public readonly friendlyUniqueId: string;
-```
-
-- *Type:* string
-
----
-
-##### `metaAttributes`<sup>Required</sup> <a name="metaAttributes" id="@cdktf/provider-acme.provider.AcmeProvider.property.metaAttributes"></a>
-
-```typescript
-public readonly metaAttributes: {[ key: string ]: any};
-```
-
-- *Type:* {[ key: string ]: any}
-
----
-
-##### `terraformResourceType`<sup>Required</sup> <a name="terraformResourceType" id="@cdktf/provider-acme.provider.AcmeProvider.property.terraformResourceType"></a>
-
-```typescript
-public readonly terraformResourceType: string;
-```
-
-- *Type:* string
-
----
-
-##### `terraformGeneratorMetadata`<sup>Optional</sup> <a name="terraformGeneratorMetadata" id="@cdktf/provider-acme.provider.AcmeProvider.property.terraformGeneratorMetadata"></a>
-
-```typescript
-public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
-```
-
-- *Type:* cdktf.TerraformProviderGeneratorMetadata
-
----
-
-##### `terraformProviderSource`<sup>Optional</sup> <a name="terraformProviderSource" id="@cdktf/provider-acme.provider.AcmeProvider.property.terraformProviderSource"></a>
-
-```typescript
-public readonly terraformProviderSource: string;
-```
-
-- *Type:* string
-
----
-
-##### `alias`<sup>Optional</sup> <a name="alias" id="@cdktf/provider-acme.provider.AcmeProvider.property.alias"></a>
-
-```typescript
-public readonly alias: string;
-```
-
-- *Type:* string
-
----
-
-##### `aliasInput`<sup>Optional</sup> <a name="aliasInput" id="@cdktf/provider-acme.provider.AcmeProvider.property.aliasInput"></a>
-
-```typescript
-public readonly aliasInput: string;
-```
-
-- *Type:* string
-
----
-
-##### `serverUrlInput`<sup>Optional</sup> <a name="serverUrlInput" id="@cdktf/provider-acme.provider.AcmeProvider.property.serverUrlInput"></a>
-
-```typescript
-public readonly serverUrlInput: string;
-```
-
-- *Type:* string
-
----
-
-##### `serverUrl`<sup>Optional</sup> <a name="serverUrl" id="@cdktf/provider-acme.provider.AcmeProvider.property.serverUrl"></a>
-
-```typescript
-public readonly serverUrl: string;
-```
-
-- *Type:* string
-
----
-
-#### Constants <a name="Constants" id="Constants"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProvider.property.tfResourceType">tfResourceType</a></code> | <code>string</code> | *No description.* |
-
----
-
-##### `tfResourceType`<sup>Required</sup> <a name="tfResourceType" id="@cdktf/provider-acme.provider.AcmeProvider.property.tfResourceType"></a>
-
-```typescript
-public readonly tfResourceType: string;
-```
-
-- *Type:* string
-
----
-
-## Structs <a name="Structs" id="Structs"></a>
-
-### AcmeProviderConfig <a name="AcmeProviderConfig" id="@cdktf/provider-acme.provider.AcmeProviderConfig"></a>
-
-#### Initializer <a name="Initializer" id="@cdktf/provider-acme.provider.AcmeProviderConfig.Initializer"></a>
-
-```typescript
-import { provider } from '@cdktf/provider-acme'
-
-const acmeProviderConfig: provider.AcmeProviderConfig = { ... }
-```
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProviderConfig.property.serverUrl">serverUrl</a></code> | <code>string</code> | Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vancluever/acme/2.13.1/docs#server_url AcmeProvider#server_url}. |
-| <code><a href="#@cdktf/provider-acme.provider.AcmeProviderConfig.property.alias">alias</a></code> | <code>string</code> | Alias name. |
-
----
-
-##### `serverUrl`<sup>Required</sup> <a name="serverUrl" id="@cdktf/provider-acme.provider.AcmeProviderConfig.property.serverUrl"></a>
-
-```typescript
-public readonly serverUrl: string;
-```
-
-- *Type:* string
-
-Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vancluever/acme/2.13.1/docs#server_url AcmeProvider#server_url}.
-
----
-
-##### `alias`<sup>Optional</sup> <a name="alias" id="@cdktf/provider-acme.provider.AcmeProviderConfig.property.alias"></a>
-
-```typescript
-public readonly alias: string;
-```
-
-- *Type:* string
-
-Alias name.
-
-Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vancluever/acme/2.13.1/docs#alias AcmeProvider#alias}
-
----
-
-
-