Consul Access Token. Sourced from CONSUL_HTTP_TOKEN
in the environment, if unset.
Optional
addressDNS name and port of the Consul HTTP endpoint specified in the format dnsname:port
. Defaults
to the local agent HTTP listener.
A constant describing the name of the Terraform backend, used as the discriminant for the union of backend configurations.
Optional
caA path to a PEM-encoded certificate authority used to verify the remote agent's certificate. Sourced
from CONSUL_CAFILE
in the environment, if unset.
Optional
certA path to a PEM-encoded certificate provided to the remote agent; requires use of key_file. Sourced
from CONSUL_CLIENT_CERT
in the environment, if unset.
Optional
datacenterThe datacenter to use. Defaults to that of the agent.
Optional
gzipWhether to compress the state data using gzip. Set to true
to compress the state data using gzip,
or false
(default) to leave it uncompressed.
Optional
httpHTTP Basic Authentication credentials to be used when communicating with Consul, in the format of
either user
or user:pass
. Sourced from CONSUL_HTTP_AUTH
, if unset.
Optional
keyA path to a PEM-encoded private key, required if cert_file is specified. Sourced from CONSUL_CLIENT_KEY
in the environment, if unset.
Path in the Consul KV store.
Optional
schemeSpecifies which protocol to use when talking to the given address - either http
or https
. TLS
support can also be enabled by setting the environment variable CONSUL_HTTP_SSL
to true
.
Optional
workspaceThe Terraform workspace from which to read state.
Generated using TypeDoc
The configuration options for a Terraform Remote State stored in the Consul backend.