Typescript: S3Backend

CDKTN Core API Reference for S3Backend in Typescript.

Initializers

import { S3Backend } from 'cdktn'

new S3Backend(scope: Construct, props: S3BackendConfig)

Name	Type	Description
scope	constructs.Construct	No description.
props	S3BackendConfig	No description.

---

scope^Required

• Type: constructs.Construct

---

props^Required

• Type: S3BackendConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to 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.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
getRemoteStateDataSource	Creates a TerraformRemoteState resource that accesses this backend.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: …constructs.IMixin[]

The mixins to apply.

---

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

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

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

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

import { S3Backend } from 'cdktn'

S3Backend.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^Required

• Type: any

Any object.

---

isTerraformElement

import { S3Backend } from 'cdktn'

S3Backend.isTerraformElement(x: any)

x^Required

• Type: any

---

isBackend

import { S3Backend } from 'cdktn'

S3Backend.isBackend(x: any)

x^Required

• Type: any

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---