> ## 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.
# Python: HttpBackend
> CDKTN Core API Reference for HttpBackend in Python.
## Initializers
```python theme={null}
import cdktn
cdktn.HttpBackend(
scope: Construct,
address: str,
client_ca_certificate_pem: str = None,
client_certificate_pem: str = None,
client_private_key_pem: str = None,
lock_address: str = None,
lock_method: str = None,
password: str = None,
retry_max: typing.Union[int, float] = None,
retry_wait_max: typing.Union[int, float] = None,
retry_wait_min: typing.Union[int, float] = None,
skip_cert_verification: bool = None,
unlock_address: str = None,
unlock_method: str = None,
update_method: str = None,
username: str = None
)
```
| **Name** | **Type** | **Description** |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| scope | constructs.Construct | *No description.* |
| address | str | (Required) The address of the REST endpoint. |
| client\_ca\_certificate\_pem | str | (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. |
| client\_certificate\_pem | str | (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. |
| client\_private\_key\_pem | str | (Optional) A PEM-encoded private key, required if client\_certificate\_pem is specified. |
| lock\_address | str | (Optional) The address of the lock REST endpoint. |
| lock\_method | str | (Optional) The HTTP method to use when locking. |
| password | str | (Optional) The password for HTTP basic authentication. |
| retry\_max | typing.Union\[int, float] | (Optional) The number of HTTP request retries. |
| retry\_wait\_max | typing.Union\[int, float] | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
| retry\_wait\_min | typing.Union\[int, float] | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
| skip\_cert\_verification | bool | (Optional) Whether to skip TLS verification. |
| unlock\_address | str | (Optional) The address of the unlock REST endpoint. |
| unlock\_method | str | (Optional) The HTTP method to use when unlocking. |
| update\_method | str | (Optional) HTTP method to use when updating state. |
| username | str | (Optional) The username for HTTP basic authentication. |
***
### `scope`Required
* *Type:* constructs.Construct
***
### `address`Required
* *Type:* str
(Required) The address of the REST endpoint.
***
### `client_ca_certificate_pem`Optional
* *Type:* str
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
***
### `client_certificate_pem`Optional
* *Type:* str
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
***
### `client_private_key_pem`Optional
* *Type:* str
(Optional) A PEM-encoded private key, required if client\_certificate\_pem is specified.
***
### `lock_address`Optional
* *Type:* str
(Optional) The address of the lock REST endpoint.
Defaults to disabled.
***
### `lock_method`Optional
* *Type:* str
(Optional) The HTTP method to use when locking.
Defaults to LOCK.
***
### `password`Optional
* *Type:* str
(Optional) The password for HTTP basic authentication.
***
### `retry_max`Optional
* *Type:* typing.Union\[int, float]
(Optional) The number of HTTP request retries.
Defaults to 2.
***
### `retry_wait_max`Optional
* *Type:* typing.Union\[int, float]
(Optional) The maximum time in seconds to wait between HTTP request attempts.
Defaults to 30.
***
### `retry_wait_min`Optional
* *Type:* typing.Union\[int, float]
(Optional) The minimum time in seconds to wait between HTTP request attempts.
Defaults to 1.
***
### `skip_cert_verification`Optional
* *Type:* bool
(Optional) Whether to skip TLS verification.
Defaults to false.
***
### `unlock_address`Optional
* *Type:* str
(Optional) The address of the unlock REST endpoint.
Defaults to disabled.
***
### `unlock_method`Optional
* *Type:* str
(Optional) The HTTP method to use when unlocking.
Defaults to UNLOCK.
***
### `update_method`Optional
* *Type:* str
(Optional) HTTP method to use when updating state.
Defaults to POST.
***
### `username`Optional
* *Type:* str
(Optional) The username for HTTP basic authentication.
***
## Methods
| **Name** | **Description** |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| to\_string | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
| add\_override | *No description.* |
| override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. |
| reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. |
| to\_hcl\_terraform | *No description.* |
| to\_metadata | *No description.* |
| to\_terraform | Adds this resource to the terraform JSON output. |
| get\_remote\_state\_data\_source | Creates a TerraformRemoteState resource that accesses this backend. |
***
### `to_string`
```python theme={null}
def to_string() -> str
```
Returns a string representation of this construct.
### `with`
```python theme={null}
def 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.
***
### `add_override`
```python theme={null}
def add_override(
path: str,
value: typing.Any
) -> None
```
#### `path`Required
* *Type:* str
***
#### `value`Required
* *Type:* typing.Any
***
### `override_logical_id`
```python theme={null}
def override_logical_id(
new_logical_id: str
) -> None
```
Overrides the auto-generated logical ID with a specific ID.
#### `new_logical_id`Required
* *Type:* str
The new logical ID to use for this stack element.
***
### `reset_override_logical_id`
```python theme={null}
def reset_override_logical_id() -> None
```
Resets a previously passed logical Id to use the auto-generated logical id again.
### `to_hcl_terraform`
```python theme={null}
def to_hcl_terraform() -> typing.Any
```
### `to_metadata`
```python theme={null}
def to_metadata() -> typing.Any
```
### `to_terraform`
```python theme={null}
def to_terraform() -> typing.Any
```
Adds this resource to the terraform JSON output.
### `get_remote_state_data_source`
```python theme={null}
def get_remote_state_data_source(
scope: Construct,
name: str,
_fromstack: str
) -> TerraformRemoteState
```
Creates a TerraformRemoteState resource that accesses this backend.
#### `scope`Required
* *Type:* constructs.Construct
***
#### `name`Required
* *Type:* str
***
#### `_fromstack`Required
* *Type:* str
***
## Static Functions
| **Name** | **Description** |
| --------------------------------------------------------------------------------------- | ----------------------------- |
| is\_construct | Checks if `x` is a construct. |
| is\_terraform\_element | *No description.* |
| is\_backend | *No description.* |
***
### `is_construct`
```python theme={null}
import cdktn
cdktn.HttpBackend.is_construct(
x: typing.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:* typing.Any
Any object.
***
### `is_terraform_element`
```python theme={null}
import cdktn
cdktn.HttpBackend.is_terraform_element(
x: typing.Any
)
```
#### `x`Required
* *Type:* typing.Any
***
### `is_backend`
```python theme={null}
import cdktn
cdktn.HttpBackend.is_backend(
x: typing.Any
)
```
#### `x`Required
* *Type:* typing.Any
***
## Properties
| **Name** | **Type** | **Description** |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- |
| node | constructs.Node | The tree node. |
| cdktf\_stack | TerraformStack | *No description.* |
| fqn | str | *No description.* |
| friendly\_unique\_id | str | *No description.* |
***
### `node`Required
```python theme={null}
node: Node
```
* *Type:* constructs.Node
The tree node.
***
### `cdktf_stack`Required
```python theme={null}
cdktf_stack: TerraformStack
```
* *Type:* TerraformStack
***
### `fqn`Required
```python theme={null}
fqn: str
```
* *Type:* str
***
### `friendly_unique_id`Required
```python theme={null}
friendly_unique_id: str
```
* *Type:* str
***