Interface ConsulRemoteStateReferenceArgs

The configuration options for a Terraform Remote State stored in the Consul backend.

interface ConsulRemoteStateReferenceArgs {
    accessToken: Input<string>;
    address?: any;
    backendType: "consul";
    caFile?: any;
    certFile?: any;
    datacenter?: any;
    gzip?: any;
    httpAuth?: any;
    keyFile?: any;
    path: Input<string>;
    scheme?: any;
    workspace?: any;
}

Properties

accessToken: Input<string>

Consul Access Token. Sourced from CONSUL_HTTP_TOKEN in the environment, if unset.

address?: any

DNS name and port of the Consul HTTP endpoint specified in the format dnsname:port. Defaults to the local agent HTTP listener.

backendType: "consul"

A constant describing the name of the Terraform backend, used as the discriminant for the union of backend configurations.

caFile?: any

A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. Sourced from CONSUL_CAFILE in the environment, if unset.

certFile?: any

A 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.

datacenter?: any

The datacenter to use. Defaults to that of the agent.

gzip?: any

Whether to compress the state data using gzip. Set to true to compress the state data using gzip, or false (default) to leave it uncompressed.

httpAuth?: any

HTTP 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.

keyFile?: any

A path to a PEM-encoded private key, required if cert_file is specified. Sourced from CONSUL_CLIENT_KEY in the environment, if unset.

path: Input<string>

Path in the Consul KV store.

scheme?: any

Specifies 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.

workspace?: any

The Terraform workspace from which to read state.

Generated using TypeDoc