Skip to main content
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 

using Io.Cdktn;

new HttpBackendConfig {
    string Address,
    string ClientCaCertificatePem = null,
    string ClientCertificatePem = null,
    string ClientPrivateKeyPem = null,
    string LockAddress = null,
    string LockMethod = null,
    string Password = null,
    double RetryMax = null,
    double RetryWaitMax = null,
    double RetryWaitMin = null,
    bool SkipCertVerification = null,
    string UnlockAddress = null,
    string UnlockMethod = null,
    string UpdateMethod = null,
    string Username = null
};

​
Properties

NameTypeDescription
Addressstring(Required) The address of the REST endpoint.
ClientCaCertificatePemstring(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
ClientCertificatePemstring(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
ClientPrivateKeyPemstring(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
LockAddressstring(Optional) The address of the lock REST endpoint.
LockMethodstring(Optional) The HTTP method to use when locking.
Passwordstring(Optional) The password for HTTP basic authentication.
RetryMaxdouble(Optional) The number of HTTP request retries.
RetryWaitMaxdouble(Optional) The maximum time in seconds to wait between HTTP request attempts.
RetryWaitMindouble(Optional) The minimum time in seconds to wait between HTTP request attempts.
SkipCertVerificationbool(Optional) Whether to skip TLS verification.
UnlockAddressstring(Optional) The address of the unlock REST endpoint.
UnlockMethodstring(Optional) The HTTP method to use when unlocking.
UpdateMethodstring(Optional) HTTP method to use when updating state.
Usernamestring(Optional) The username for HTTP basic authentication.

​
AddressRequired 

public string Address { get; set; }
  • Type: string
(Required) The address of the REST endpoint.

​
ClientCaCertificatePemOptional 

public string ClientCaCertificatePem { get; set; }
  • Type: string
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

​
ClientCertificatePemOptional 

public string ClientCertificatePem { get; set; }
  • Type: string
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

​
ClientPrivateKeyPemOptional 

public string ClientPrivateKeyPem { get; set; }
  • Type: string
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

​
LockAddressOptional 

public string LockAddress { get; set; }
  • Type: string
(Optional) The address of the lock REST endpoint. Defaults to disabled.

​
LockMethodOptional 

public string LockMethod { get; set; }
  • Type: string
(Optional) The HTTP method to use when locking. Defaults to LOCK.

​
PasswordOptional 

public string Password { get; set; }
  • Type: string
(Optional) The password for HTTP basic authentication.

​
RetryMaxOptional 

public double RetryMax { get; set; }
  • Type: double
(Optional) The number of HTTP request retries. Defaults to 2.

​
RetryWaitMaxOptional 

public double RetryWaitMax { get; set; }
  • Type: double
(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

​
RetryWaitMinOptional 

public double RetryWaitMin { get; set; }
  • Type: double
(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

​
SkipCertVerificationOptional 

public bool SkipCertVerification { get; set; }
  • Type: bool
(Optional) Whether to skip TLS verification. Defaults to false.

​
UnlockAddressOptional 

public string UnlockAddress { get; set; }
  • Type: string
(Optional) The address of the unlock REST endpoint. Defaults to disabled.

​
UnlockMethodOptional 

public string UnlockMethod { get; set; }
  • Type: string
(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

​
UpdateMethodOptional 

public string UpdateMethod { get; set; }
  • Type: string
(Optional) HTTP method to use when updating state. Defaults to POST.

​
UsernameOptional 

public string Username { get; set; }
  • Type: string
(Optional) The username for HTTP basic authentication.