com.hashicorp.cdktf

Interface HttpBackendConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DataTerraformRemoteStateHttpConfig

All Known Implementing Classes:

DataTerraformRemoteStateHttpConfig.Jsii$Proxy, HttpBackendConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-04-14T16:14:45.835Z")
 @Stability(value=Experimental)
public interface HttpBackendConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) 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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpBackendConfig.Builder A builder for HttpBackendConfig
static class	HttpBackendConfig.Jsii$Proxy An implementation for HttpBackendConfig

Method Summary

Modifier and Type	Method and Description
static HttpBackendConfig.Builder	builder()
String	getAddress() (experimental) (Required) The address of the REST endpoint.
default String	getLockAddress() (experimental) (Optional) The address of the lock REST endpoint.
default String	getLockMethod() (experimental) (Optional) The HTTP method to use when locking.
default String	getPassword() (experimental) (Optional) The password for HTTP basic authentication.
default Number	getRetryMax() (experimental) (Optional) The number of HTTP request retries.
default Number	getRetryWaitMax() (experimental) (Optional) The maximum time in seconds to wait between HTTP request attempts.
default Number	getRetryWaitMin() (experimental) (Optional) The minimum time in seconds to wait between HTTP request attempts.
default Boolean	getSkipCertVerification() (experimental) (Optional) Whether to skip TLS verification.
default String	getUnlockAddress() (experimental) (Optional) The address of the unlock REST endpoint.
default String	getUnlockMethod() (experimental) (Optional) The HTTP method to use when unlocking.
default String	getUpdateMethod() (experimental) (Optional) HTTP method to use when updating state.
default String	getUsername() (experimental) (Optional) The username for HTTP basic authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddress

@Stability(value=Experimental)
 @NotNull
String getAddress()

(experimental) (Required) The address of the REST endpoint.

getLockAddress

@Stability(value=Experimental)
 @Nullable
default String getLockAddress()

(experimental) (Optional) The address of the lock REST endpoint.

Defaults to disabled.

getLockMethod

@Stability(value=Experimental)
 @Nullable
default String getLockMethod()

(experimental) (Optional) The HTTP method to use when locking.

Defaults to LOCK.

getPassword

@Stability(value=Experimental)
 @Nullable
default String getPassword()

(experimental) (Optional) The password for HTTP basic authentication.

getRetryMax

@Stability(value=Experimental)
 @Nullable
default Number getRetryMax()

(experimental) (Optional) The number of HTTP request retries.

Defaults to 2.

getRetryWaitMax

@Stability(value=Experimental)
 @Nullable
default Number getRetryWaitMax()

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

Defaults to 30.

getRetryWaitMin

@Stability(value=Experimental)
 @Nullable
default Number getRetryWaitMin()

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

Defaults to 1.

getSkipCertVerification

@Stability(value=Experimental)
 @Nullable
default Boolean getSkipCertVerification()

(experimental) (Optional) Whether to skip TLS verification.

Defaults to false.

getUnlockAddress

@Stability(value=Experimental)
 @Nullable
default String getUnlockAddress()

(experimental) (Optional) The address of the unlock REST endpoint.

Defaults to disabled.

getUnlockMethod

@Stability(value=Experimental)
 @Nullable
default String getUnlockMethod()

(experimental) (Optional) The HTTP method to use when unlocking.

Defaults to UNLOCK.

getUpdateMethod

@Stability(value=Experimental)
 @Nullable
default String getUpdateMethod()

(experimental) (Optional) HTTP method to use when updating state.

Defaults to POST.

getUsername

@Stability(value=Experimental)
 @Nullable
default String getUsername()

(experimental) (Optional) The username for HTTP basic authentication.

builder

@Stability(value=Experimental)
static HttpBackendConfig.Builder builder()

Returns:

a HttpBackendConfig.Builder of HttpBackendConfig