Package com.hashicorp.cdktf

Class HttpBackend.Builder

java.lang.Object
com.hashicorp.cdktf.HttpBackend.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<HttpBackend>
Enclosing class:
HttpBackend
@Stability(Experimental) public static final class HttpBackend.Builder extends Object implements software.amazon.jsii.Builder<HttpBackend>
(experimental) A fluent builder for HttpBackend.

  • Method Details

    • create

      @Stability(Experimental) public static HttpBackend.Builder create(software.constructs.Construct scope)
      Parameters:
      scope - This parameter is required.
      Returns:
      a new instance of HttpBackend.Builder.

    • address

      @Stability(Experimental) public HttpBackend.Builder address(String address)
      (experimental) (Required) The address of the REST endpoint.

      Parameters:
      address - (Required) The address of the REST endpoint. This parameter is required.
      Returns:
      this

    • clientCaCertificatePem

      @Stability(Experimental) public HttpBackend.Builder clientCaCertificatePem(String clientCaCertificatePem)
      (experimental) (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

      Parameters:
      clientCaCertificatePem - (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. This parameter is required.
      Returns:
      this

    • clientCertificatePem

      @Stability(Experimental) public HttpBackend.Builder clientCertificatePem(String clientCertificatePem)
      (experimental) (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

      Parameters:
      clientCertificatePem - (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. This parameter is required.
      Returns:
      this

    • clientPrivateKeyPem

      @Stability(Experimental) public HttpBackend.Builder clientPrivateKeyPem(String clientPrivateKeyPem)
      (experimental) (Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

      Parameters:
      clientPrivateKeyPem - (Optional) A PEM-encoded private key, required if client_certificate_pem is specified. This parameter is required.
      Returns:
      this

    • lockAddress

      @Stability(Experimental) public HttpBackend.Builder lockAddress(String lockAddress)
      (experimental) (Optional) The address of the lock REST endpoint.

      Defaults to disabled.

      Parameters:
      lockAddress - (Optional) The address of the lock REST endpoint. This parameter is required.
      Returns:
      this

    • lockMethod

      @Stability(Experimental) public HttpBackend.Builder lockMethod(String lockMethod)
      (experimental) (Optional) The HTTP method to use when locking.

      Defaults to LOCK.

      Parameters:
      lockMethod - (Optional) The HTTP method to use when locking. This parameter is required.
      Returns:
      this

    • password

      @Stability(Experimental) public HttpBackend.Builder password(String password)
      (experimental) (Optional) The password for HTTP basic authentication.

      Parameters:
      password - (Optional) The password for HTTP basic authentication. This parameter is required.
      Returns:
      this

    • retryMax

      @Stability(Experimental) public HttpBackend.Builder retryMax(Number retryMax)
      (experimental) (Optional) The number of HTTP request retries.

      Defaults to 2.

      Parameters:
      retryMax - (Optional) The number of HTTP request retries. This parameter is required.
      Returns:
      this

    • retryWaitMax

      @Stability(Experimental) public HttpBackend.Builder retryWaitMax(Number retryWaitMax)
      (experimental) (Optional) The maximum time in seconds to wait between HTTP request attempts.

      Defaults to 30.

      Parameters:
      retryWaitMax - (Optional) The maximum time in seconds to wait between HTTP request attempts. This parameter is required.
      Returns:
      this

    • retryWaitMin

      @Stability(Experimental) public HttpBackend.Builder retryWaitMin(Number retryWaitMin)
      (experimental) (Optional) The minimum time in seconds to wait between HTTP request attempts.

      Defaults to 1.

      Parameters:
      retryWaitMin - (Optional) The minimum time in seconds to wait between HTTP request attempts. This parameter is required.
      Returns:
      this

    • skipCertVerification

      @Stability(Experimental) public HttpBackend.Builder skipCertVerification(Boolean skipCertVerification)
      (experimental) (Optional) Whether to skip TLS verification.

      Defaults to false.

      Parameters:
      skipCertVerification - (Optional) Whether to skip TLS verification. This parameter is required.
      Returns:
      this

    • unlockAddress

      @Stability(Experimental) public HttpBackend.Builder unlockAddress(String unlockAddress)
      (experimental) (Optional) The address of the unlock REST endpoint.

      Defaults to disabled.

      Parameters:
      unlockAddress - (Optional) The address of the unlock REST endpoint. This parameter is required.
      Returns:
      this

    • unlockMethod

      @Stability(Experimental) public HttpBackend.Builder unlockMethod(String unlockMethod)
      (experimental) (Optional) The HTTP method to use when unlocking.

      Defaults to UNLOCK.

      Parameters:
      unlockMethod - (Optional) The HTTP method to use when unlocking. This parameter is required.
      Returns:
      this

    • updateMethod

      @Stability(Experimental) public HttpBackend.Builder updateMethod(String updateMethod)
      (experimental) (Optional) HTTP method to use when updating state.

      Defaults to POST.

      Parameters:
      updateMethod - (Optional) HTTP method to use when updating state. This parameter is required.
      Returns:
      this

    • username

      @Stability(Experimental) public HttpBackend.Builder username(String username)
      (experimental) (Optional) The username for HTTP basic authentication.

      Parameters:
      username - (Optional) The username for HTTP basic authentication. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public HttpBackend build()
      Specified by:
      build in interface software.amazon.jsii.Builder<HttpBackend>
      Returns:
      a newly built instance of HttpBackend.