Package com.hashicorp.cdktf

Interface ConsulBackendConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
DataTerraformRemoteStateConsulConfig
All Known Implementing Classes:
ConsulBackendConfig.Jsii$Proxy, DataTerraformRemoteStateConsulConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.79.0 (build b22f628)", date="2023-07-26T11:31:27.471Z") @Stability(Experimental) public interface ConsulBackendConfig extends software.amazon.jsii.JsiiSerializable
(experimental) Stores the state in the Consul KV store at a given path. This backend supports state locking.

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ConsulBackendConfig.Builder
    A builder for ConsulBackendConfig
    static final class 
    ConsulBackendConfig.Jsii$Proxy
    An implementation for ConsulBackendConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    static ConsulBackendConfig.Builder
    builder()
     
    String
    getAccessToken()
    (experimental) (Required) Access token.
    default String
    getAddress()
    (experimental) (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
    default String
    getCaFile()
    (experimental) (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
    default String
    getCertFile()
    (experimental) (Optional) A path to a PEM-encoded certificate provided to the remote agent;
    default String
    getDatacenter()
    (experimental) (Optional) The datacenter to use.
    default Boolean
    getGzip()
    (experimental) (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
    default String
    getHttpAuth()
    (experimental) (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
    default String
    getKeyFile()
    (experimental) (Optional) A path to a PEM-encoded private key, required if cert_file is specified.
    default Boolean
    getLock()
    (experimental) (Optional) false to disable locking.
    String
    getPath()
    (experimental) (Required) Path in the Consul KV store.
    default String
    getScheme()
    (experimental) (Optional) Specifies what protocol to use when talking to the given address,either http or https.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getAccessToken

      @Stability(Experimental) @NotNull String getAccessToken()
      (experimental) (Required) Access token.

    • getPath

      @Stability(Experimental) @NotNull String getPath()
      (experimental) (Required) Path in the Consul KV store.

    • getAddress

      @Stability(Experimental) @Nullable default String getAddress()
      (experimental) (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.

      Defaults to the local agent HTTP listener.

    • getCaFile

      @Stability(Experimental) @Nullable default String getCaFile()
      (experimental) (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

    • getCertFile

      @Stability(Experimental) @Nullable default String getCertFile()
      (experimental) (Optional) A path to a PEM-encoded certificate provided to the remote agent;

      requires use of key_file.

    • getDatacenter

      @Stability(Experimental) @Nullable default String getDatacenter()
      (experimental) (Optional) The datacenter to use.

      Defaults to that of the agent.

    • getGzip

      @Stability(Experimental) @Nullable default Boolean getGzip()
      (experimental) (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

    • getHttpAuth

      @Stability(Experimental) @Nullable default String getHttpAuth()
      (experimental) (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

    • getKeyFile

      @Stability(Experimental) @Nullable default String getKeyFile()
      (experimental) (Optional) A path to a PEM-encoded private key, required if cert_file is specified.

    • getLock

      @Stability(Experimental) @Nullable default Boolean getLock()
      (experimental) (Optional) false to disable locking.

      This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.

    • getScheme

      @Stability(Experimental) @Nullable default String getScheme()
      (experimental) (Optional) Specifies what protocol to use when talking to the given address,either http or https.

      SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.

    • builder

      @Stability(Experimental) static ConsulBackendConfig.Builder builder()
      Returns:
      a ConsulBackendConfig.Builder of ConsulBackendConfig