Typescript: HttpBackendConfig

CDKTN Core API Reference for HttpBackendConfig in Typescript.

Stores the state using a simple REST client.

State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable.

This backend optionally supports state locking. When locking support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The endpoint should return a 423: Locked or 409: Conflict with the holding lock info when it’s already taken, 200: OK for success. Any other status will be considered an error. The ID of the holding lock info will be added as a query parameter to state updates requests.

Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/http

Initializer

import { HttpBackendConfig } from 'cdktn'

const httpBackendConfig: HttpBackendConfig = { ... }

Properties

Name	Type	Description
address	string	(Required) The address of the REST endpoint.
clientCaCertificatePem	string	(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePem	string	(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPem	string	(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddress	string	(Optional) The address of the lock REST endpoint.
lockMethod	string	(Optional) The HTTP method to use when locking.
password	string	(Optional) The password for HTTP basic authentication.
retryMax	number	(Optional) The number of HTTP request retries.
retryWaitMax	number	(Optional) The maximum time in seconds to wait between HTTP request attempts.
retryWaitMin	number	(Optional) The minimum time in seconds to wait between HTTP request attempts.
skipCertVerification	boolean	(Optional) Whether to skip TLS verification.
unlockAddress	string	(Optional) The address of the unlock REST endpoint.
unlockMethod	string	(Optional) The HTTP method to use when unlocking.
updateMethod	string	(Optional) HTTP method to use when updating state.
username	string	(Optional) The username for HTTP basic authentication.

---

address^Required

public readonly address: string;

• Type: string

(Required) The address of the REST endpoint.

---

clientCaCertificatePem^Optional

public readonly clientCaCertificatePem: string;

• Type: string

(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

---

clientCertificatePem^Optional

public readonly clientCertificatePem: string;

• Type: string

(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

---

clientPrivateKeyPem^Optional

public readonly clientPrivateKeyPem: string;

• Type: string

(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

---

lockAddress^Optional

public readonly lockAddress: string;

• Type: string

(Optional) The address of the lock REST endpoint.

Defaults to disabled.

---

lockMethod^Optional

public readonly lockMethod: string;

• Type: string

(Optional) The HTTP method to use when locking.

Defaults to LOCK.

---

password^Optional

public readonly password: string;

• Type: string

(Optional) The password for HTTP basic authentication.

---

retryMax^Optional

public readonly retryMax: number;

• Type: number

(Optional) The number of HTTP request retries.

Defaults to 2.

---

retryWaitMax^Optional

public readonly retryWaitMax: number;

• Type: number

(Optional) The maximum time in seconds to wait between HTTP request attempts.

Defaults to 30.

---

retryWaitMin^Optional

public readonly retryWaitMin: number;

• Type: number

(Optional) The minimum time in seconds to wait between HTTP request attempts.

Defaults to 1.

---

skipCertVerification^Optional

public readonly skipCertVerification: boolean;

• Type: boolean

(Optional) Whether to skip TLS verification.

Defaults to false.

---

unlockAddress^Optional

public readonly unlockAddress: string;

• Type: string

(Optional) The address of the unlock REST endpoint.

Defaults to disabled.

---

unlockMethod^Optional

public readonly unlockMethod: string;

• Type: string

(Optional) The HTTP method to use when unlocking.

Defaults to UNLOCK.

---

updateMethod^Optional

public readonly updateMethod: string;

• Type: string

(Optional) HTTP method to use when updating state.

Defaults to POST.

---

username^Optional

public readonly username: string;

• Type: string

(Optional) The username for HTTP basic authentication.

---