# cdktf-surreal-backend
This is library to create a CDKTF construct for [terraform-backend-surreal](https://github.com/awlsring/terraform-backend-surreal). This library vends a single construct, `SurrealBackend`, which extends the default `HttpBackend` construct to make instantiation of this easier.
## Usage
### Example
```typescript
import { TerraformStack } from "cdktf";
import { SurrealBackend } from '@awlsring/cdktf-surreal-backend';
export class MyStack extends TerraformStack {
constructor(scope: Construct, name: string, props: MyStackProps) {
super(scope, name);
const backend = new SurrealBackend(this, 'Backend', {
address: 'https://localhost:8032',
project: "homelab",
stack: "infra",
username: "terraform",
password: "alligator3",
});
... // other stuff
}
}
```
### Construct Properties:
* address: The address your backend sever is reachable at.
* project: The project name to use for this stack.
* stack: The stack name to use for this stack. stacks names must be unique across a project.
* username: The username to use for authentication, configured in the server's config.yaml file
* password: The password to use for authentication, configured in the server's config.yaml file
# API Reference
## Constructs
### SurrealBackend
#### Initializers
```typescript
import { SurrealBackend } from '@awlsring/cdktf-surreal-backend'
new SurrealBackend(scope: Construct, props: SurrealBackendProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| props | SurrealBackendProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `props`Required
- *Type:* SurrealBackendProps
---
#### Methods
| **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. |
| getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `addOverride`
```typescript
public addOverride(path: string, value: any): void
```
###### `path`Required
- *Type:* string
---
###### `value`Required
- *Type:* any
---
##### `overrideLogicalId`
```typescript
public overrideLogicalId(newLogicalId: string): void
```
Overrides the auto-generated logical ID with a specific ID.
###### `newLogicalId`Required
- *Type:* string
The new logical ID to use for this stack element.
---
##### `resetOverrideLogicalId`
```typescript
public resetOverrideLogicalId(): void
```
Resets a previously passed logical Id to use the auto-generated logical id again.
##### `toMetadata`
```typescript
public toMetadata(): any
```
##### `toTerraform`
```typescript
public toTerraform(): any
```
Adds this resource to the terraform JSON output.
##### `getRemoteStateDataSource`
```typescript
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
```
Creates a TerraformRemoteState resource that accesses this backend.
###### `scope`Required
- *Type:* constructs.Construct
---
###### `name`Required
- *Type:* string
---
###### `_fromStack`Required
- *Type:* string
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isTerraformElement | *No description.* |
| isBackend | *No description.* |
---
##### ~~`isConstruct`~~
```typescript
import { SurrealBackend } from '@awlsring/cdktf-surreal-backend'
SurrealBackend.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isTerraformElement`
```typescript
import { SurrealBackend } from '@awlsring/cdktf-surreal-backend'
SurrealBackend.isTerraformElement(x: any)
```
###### `x`Required
- *Type:* any
---
##### `isBackend`
```typescript
import { SurrealBackend } from '@awlsring/cdktf-surreal-backend'
SurrealBackend.isBackend(x: any)
```
###### `x`Required
- *Type:* any
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| cdktfStack | cdktf.TerraformStack | *No description.* |
| fqn | string | *No description.* |
| friendlyUniqueId | string | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `cdktfStack`Required
```typescript
public readonly cdktfStack: TerraformStack;
```
- *Type:* cdktf.TerraformStack
---
##### `fqn`Required
```typescript
public readonly fqn: string;
```
- *Type:* string
---
##### `friendlyUniqueId`Required
```typescript
public readonly friendlyUniqueId: string;
```
- *Type:* string
---
## Structs
### SurrealBackendProps
#### Initializer
```typescript
import { SurrealBackendProps } from '@awlsring/cdktf-surreal-backend'
const surrealBackendProps: SurrealBackendProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| address | string | *No description.* |
| password | string | *No description.* |
| project | string | *No description.* |
| stack | string | *No description.* |
| username | string | *No description.* |
| skipCertVerification | boolean | *No description.* |
---
##### `address`Required
```typescript
public readonly address: string;
```
- *Type:* string
---
##### `password`Required
```typescript
public readonly password: string;
```
- *Type:* string
---
##### `project`Required
```typescript
public readonly project: string;
```
- *Type:* string
---
##### `stack`Required
```typescript
public readonly stack: string;
```
- *Type:* string
---
##### `username`Required
```typescript
public readonly username: string;
```
- *Type:* string
---
##### `skipCertVerification`Optional
```typescript
public readonly skipCertVerification: boolean;
```
- *Type:* boolean
---