> ## Documentation Index
> Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Go: S3Backend

> CDKTN Core API Reference for S3Backend in Go.

## Initializers <a name="Initializers" id="cdktn.S3Backend.Initializer" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.NewS3Backend(scope Construct, props S3BackendConfig) S3Backend
```

| **Name**                                                                      | **Type**                                                           | **Description**   |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------ | ----------------- |
| <code><a href="#cdktn.S3Backend.Initializer.parameter.scope">scope</a></code> | <code>github.com/aws/constructs-go/constructs/v10.Construct</code> | *No description.* |
| <code><a href="#cdktn.S3Backend.Initializer.parameter.props">props</a></code> | <code><a href="#cdktn.S3BackendConfig">S3BackendConfig</a></code>  | *No description.* |

***

### `scope`<sup>Required</sup> <a name="scope" id="cdktn.S3Backend.Initializer.parameter.scope" />

* *Type:* github.com/aws/constructs-go/constructs/v10.Construct

***

### `props`<sup>Required</sup> <a name="props" id="cdktn.S3Backend.Initializer.parameter.props" />

* *Type:* <a href="#cdktn.S3BackendConfig">S3BackendConfig</a>

***

## Methods <a name="Methods" id="Methods" />

| **Name**                                                                                      | **Description**                                                                   |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.S3Backend.toString">ToString</a></code>                                 | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.S3Backend.with">With</a></code>                                         | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.S3Backend.addOverride">AddOverride</a></code>                           | *No description.*                                                                 |
| <code><a href="#cdktn.S3Backend.overrideLogicalId">OverrideLogicalId</a></code>               | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.S3Backend.resetOverrideLogicalId">ResetOverrideLogicalId</a></code>     | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.S3Backend.toHclTerraform">ToHclTerraform</a></code>                     | *No description.*                                                                 |
| <code><a href="#cdktn.S3Backend.toMetadata">ToMetadata</a></code>                             | *No description.*                                                                 |
| <code><a href="#cdktn.S3Backend.toTerraform">ToTerraform</a></code>                           | Adds this resource to the terraform JSON output.                                  |
| <code><a href="#cdktn.S3Backend.getRemoteStateDataSource">GetRemoteStateDataSource</a></code> | Creates a TerraformRemoteState resource that accesses this backend.               |

***

### `ToString` <a name="ToString" id="cdktn.S3Backend.toString" />

```go theme={null}
func ToString() *string
```

Returns a string representation of this construct.

### `With` <a name="With" id="cdktn.S3Backend.with" />

```go theme={null}
func 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`<sup>Required</sup> <a name="mixins" id="cdktn.S3Backend.with.parameter.mixins" />

* *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin

The mixins to apply.

***

### `AddOverride` <a name="AddOverride" id="cdktn.S3Backend.addOverride" />

```go theme={null}
func AddOverride(path *string, value interface{})
```

#### `path`<sup>Required</sup> <a name="path" id="cdktn.S3Backend.addOverride.parameter.path" />

* *Type:* \*string

***

#### `value`<sup>Required</sup> <a name="value" id="cdktn.S3Backend.addOverride.parameter.value" />

* *Type:* interface\{}

***

### `OverrideLogicalId` <a name="OverrideLogicalId" id="cdktn.S3Backend.overrideLogicalId" />

```go theme={null}
func OverrideLogicalId(newLogicalId *string)
```

Overrides the auto-generated logical ID with a specific ID.

#### `newLogicalId`<sup>Required</sup> <a name="newLogicalId" id="cdktn.S3Backend.overrideLogicalId.parameter.newLogicalId" />

* *Type:* \*string

The new logical ID to use for this stack element.

***

### `ResetOverrideLogicalId` <a name="ResetOverrideLogicalId" id="cdktn.S3Backend.resetOverrideLogicalId" />

```go theme={null}
func ResetOverrideLogicalId()
```

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

### `ToHclTerraform` <a name="ToHclTerraform" id="cdktn.S3Backend.toHclTerraform" />

```go theme={null}
func ToHclTerraform() interface{}
```

### `ToMetadata` <a name="ToMetadata" id="cdktn.S3Backend.toMetadata" />

```go theme={null}
func ToMetadata() interface{}
```

### `ToTerraform` <a name="ToTerraform" id="cdktn.S3Backend.toTerraform" />

```go theme={null}
func ToTerraform() interface{}
```

Adds this resource to the terraform JSON output.

### `GetRemoteStateDataSource` <a name="GetRemoteStateDataSource" id="cdktn.S3Backend.getRemoteStateDataSource" />

```go theme={null}
func GetRemoteStateDataSource(scope Construct, name *string, _fromStack *string) TerraformRemoteState
```

Creates a TerraformRemoteState resource that accesses this backend.

#### `scope`<sup>Required</sup> <a name="scope" id="cdktn.S3Backend.getRemoteStateDataSource.parameter.scope" />

* *Type:* github.com/aws/constructs-go/constructs/v10.Construct

***

#### `name`<sup>Required</sup> <a name="name" id="cdktn.S3Backend.getRemoteStateDataSource.parameter.name" />

* *Type:* \*string

***

#### `_fromStack`<sup>Required</sup> <a name="_fromStack" id="cdktn.S3Backend.getRemoteStateDataSource.parameter._fromStack" />

* *Type:* \*string

***

## Static Functions <a name="Static Functions" id="Static Functions" />

| **Name**                                                                          | **Description**               |
| --------------------------------------------------------------------------------- | ----------------------------- |
| <code><a href="#cdktn.S3Backend.isConstruct">IsConstruct</a></code>               | Checks if `x` is a construct. |
| <code><a href="#cdktn.S3Backend.isTerraformElement">IsTerraformElement</a></code> | *No description.*             |
| <code><a href="#cdktn.S3Backend.isBackend">IsBackend</a></code>                   | *No description.*             |

***

### `IsConstruct` <a name="IsConstruct" id="cdktn.S3Backend.isConstruct" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.S3Backend_IsConstruct(x interface{}) *bool
```

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="cdktn.S3Backend.isConstruct.parameter.x" />

* *Type:* interface\{}

Any object.

***

### `IsTerraformElement` <a name="IsTerraformElement" id="cdktn.S3Backend.isTerraformElement" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.S3Backend_IsTerraformElement(x interface{}) *bool
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.S3Backend.isTerraformElement.parameter.x" />

* *Type:* interface\{}

***

### `IsBackend` <a name="IsBackend" id="cdktn.S3Backend.isBackend" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.S3Backend_IsBackend(x interface{}) *bool
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.S3Backend.isBackend.parameter.x" />

* *Type:* interface\{}

***

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                               | **Type**                                                        | **Description**   |
| -------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.S3Backend.property.node">Node</a></code>                         | <code>github.com/aws/constructs-go/constructs/v10.Node</code>   | The tree node.    |
| <code><a href="#cdktn.S3Backend.property.cdktfStack">CdktfStack</a></code>             | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code> | *No description.* |
| <code><a href="#cdktn.S3Backend.property.fqn">Fqn</a></code>                           | <code>\*string</code>                                           | *No description.* |
| <code><a href="#cdktn.S3Backend.property.friendlyUniqueId">FriendlyUniqueId</a></code> | <code>\*string</code>                                           | *No description.* |

***

### `Node`<sup>Required</sup> <a name="Node" id="cdktn.S3Backend.property.node" />

```go theme={null}
func Node() Node
```

* *Type:* github.com/aws/constructs-go/constructs/v10.Node

The tree node.

***

### `CdktfStack`<sup>Required</sup> <a name="CdktfStack" id="cdktn.S3Backend.property.cdktfStack" />

```go theme={null}
func CdktfStack() TerraformStack
```

* *Type:* <a href="#cdktn.TerraformStack">TerraformStack</a>

***

### `Fqn`<sup>Required</sup> <a name="Fqn" id="cdktn.S3Backend.property.fqn" />

```go theme={null}
func Fqn() *string
```

* *Type:* \*string

***

### `FriendlyUniqueId`<sup>Required</sup> <a name="FriendlyUniqueId" id="cdktn.S3Backend.property.friendlyUniqueId" />

```go theme={null}
func FriendlyUniqueId() *string
```

* *Type:* \*string

***
