Skip to main content

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.

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 io.cdktn.cdktn.HttpBackendConfig;

HttpBackendConfig.builder()
    .address(java.lang.String)
//  .clientCaCertificatePem(java.lang.String)
//  .clientCertificatePem(java.lang.String)
//  .clientPrivateKeyPem(java.lang.String)
//  .lockAddress(java.lang.String)
//  .lockMethod(java.lang.String)
//  .password(java.lang.String)
//  .retryMax(java.lang.Number)
//  .retryWaitMax(java.lang.Number)
//  .retryWaitMin(java.lang.Number)
//  .skipCertVerification(java.lang.Boolean)
//  .unlockAddress(java.lang.String)
//  .unlockMethod(java.lang.String)
//  .updateMethod(java.lang.String)
//  .username(java.lang.String)
    .build();

​
Properties

NameTypeDescription
addressjava.lang.String(Required) The address of the REST endpoint.
clientCaCertificatePemjava.lang.String(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePemjava.lang.String(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPemjava.lang.String(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddressjava.lang.String(Optional) The address of the lock REST endpoint.
lockMethodjava.lang.String(Optional) The HTTP method to use when locking.
passwordjava.lang.String(Optional) The password for HTTP basic authentication.
retryMaxjava.lang.Number(Optional) The number of HTTP request retries.
retryWaitMaxjava.lang.Number(Optional) The maximum time in seconds to wait between HTTP request attempts.
retryWaitMinjava.lang.Number(Optional) The minimum time in seconds to wait between HTTP request attempts.
skipCertVerificationjava.lang.Boolean(Optional) Whether to skip TLS verification.
unlockAddressjava.lang.String(Optional) The address of the unlock REST endpoint.
unlockMethodjava.lang.String(Optional) The HTTP method to use when unlocking.
updateMethodjava.lang.String(Optional) HTTP method to use when updating state.
usernamejava.lang.String(Optional) The username for HTTP basic authentication.

​
addressRequired 

public java.lang.String getAddress();
  • Type: java.lang.String
(Required) The address of the REST endpoint.

​
clientCaCertificatePemOptional 

public java.lang.String getClientCaCertificatePem();
  • Type: java.lang.String
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

​
clientCertificatePemOptional 

public java.lang.String getClientCertificatePem();
  • Type: java.lang.String
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

​
clientPrivateKeyPemOptional 

public java.lang.String getClientPrivateKeyPem();
  • Type: java.lang.String
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

​
lockAddressOptional 

public java.lang.String getLockAddress();
  • Type: java.lang.String
(Optional) The address of the lock REST endpoint. Defaults to disabled.

​
lockMethodOptional 

public java.lang.String getLockMethod();
  • Type: java.lang.String
(Optional) The HTTP method to use when locking. Defaults to LOCK.

​
passwordOptional 

public java.lang.String getPassword();
  • Type: java.lang.String
(Optional) The password for HTTP basic authentication.

​
retryMaxOptional 

public java.lang.Number getRetryMax();
  • Type: java.lang.Number
(Optional) The number of HTTP request retries. Defaults to 2.

​
retryWaitMaxOptional 

public java.lang.Number getRetryWaitMax();
  • Type: java.lang.Number
(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

​
retryWaitMinOptional 

public java.lang.Number getRetryWaitMin();
  • Type: java.lang.Number
(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

​
skipCertVerificationOptional 

public java.lang.Boolean getSkipCertVerification();
  • Type: java.lang.Boolean
(Optional) Whether to skip TLS verification. Defaults to false.

​
unlockAddressOptional 

public java.lang.String getUnlockAddress();
  • Type: java.lang.String
(Optional) The address of the unlock REST endpoint. Defaults to disabled.

​
unlockMethodOptional 

public java.lang.String getUnlockMethod();
  • Type: java.lang.String
(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

​
updateMethodOptional 

public java.lang.String getUpdateMethod();
  • Type: java.lang.String
(Optional) HTTP method to use when updating state. Defaults to POST.

​
usernameOptional 

public java.lang.String getUsername();
  • Type: java.lang.String
(Optional) The username for HTTP basic authentication.