com.hashicorp.cdktf

Class ConsulBackend.Builder

java.lang.Object

com.hashicorp.cdktf.ConsulBackend.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ConsulBackend>

Enclosing class:

ConsulBackend

@Stability(value=Experimental)
public static final class ConsulBackend.Builder
extends Object
implements software.amazon.jsii.Builder<ConsulBackend>

(experimental) A fluent builder for ConsulBackend.

Method Summary

Modifier and Type	Method and Description
ConsulBackend.Builder	accessToken(String accessToken) (experimental) (Required) Access token.
ConsulBackend.Builder	address(String address) (experimental) (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
ConsulBackend	build()
ConsulBackend.Builder	caFile(String caFile) (experimental) (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
ConsulBackend.Builder	certFile(String certFile) (experimental) (Optional) A path to a PEM-encoded certificate provided to the remote agent;
static ConsulBackend.Builder	create(software.constructs.Construct scope)
ConsulBackend.Builder	datacenter(String datacenter) (experimental) (Optional) The datacenter to use.
ConsulBackend.Builder	gzip(Boolean gzip) (experimental) (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
ConsulBackend.Builder	httpAuth(String httpAuth) (experimental) (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
ConsulBackend.Builder	keyFile(String keyFile) (experimental) (Optional) A path to a PEM-encoded private key, required if cert_file is specified.
ConsulBackend.Builder	lock(Boolean lock) (experimental) (Optional) false to disable locking.
ConsulBackend.Builder	path(String path) (experimental) (Required) Path in the Consul KV store.
ConsulBackend.Builder	scheme(String scheme) (experimental) (Optional) Specifies what protocol to use when talking to the given address,either http or https.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static ConsulBackend.Builder create(software.constructs.Construct scope)

Parameters:

scope - This parameter is required.

Returns:

a new instance of ConsulBackend.Builder.

accessToken

@Stability(value=Experimental)
public ConsulBackend.Builder accessToken(String accessToken)

(experimental) (Required) Access token.

Parameters:

accessToken - (Required) Access token. This parameter is required.

Returns:

this

path

@Stability(value=Experimental)
public ConsulBackend.Builder path(String path)

(experimental) (Required) Path in the Consul KV store.

Parameters:

path - (Required) Path in the Consul KV store. This parameter is required.

Returns:

this

address

@Stability(value=Experimental)
public ConsulBackend.Builder address(String address)

(experimental) (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.

Defaults to the local agent HTTP listener.

Parameters:

address - (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. This parameter is required.

Returns:

this

caFile

@Stability(value=Experimental)
public ConsulBackend.Builder caFile(String caFile)

(experimental) (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

Parameters:

caFile - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. This parameter is required.

Returns:

this

certFile

@Stability(value=Experimental)
public ConsulBackend.Builder certFile(String certFile)

(experimental) (Optional) A path to a PEM-encoded certificate provided to the remote agent;

requires use of key_file.

Parameters:

certFile - (Optional) A path to a PEM-encoded certificate provided to the remote agent;. This parameter is required.

Returns:

this

datacenter

@Stability(value=Experimental)
public ConsulBackend.Builder datacenter(String datacenter)

(experimental) (Optional) The datacenter to use.

Defaults to that of the agent.

Parameters:

datacenter - (Optional) The datacenter to use. This parameter is required.

Returns:

this

gzip

@Stability(value=Experimental)
public ConsulBackend.Builder gzip(Boolean gzip)

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

Parameters:

gzip - (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed. This parameter is required.

Returns:

this

httpAuth

@Stability(value=Experimental)
public ConsulBackend.Builder httpAuth(String httpAuth)

(experimental) (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

Parameters:

httpAuth - (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This parameter is required.

Returns:

this

keyFile

@Stability(value=Experimental)
public ConsulBackend.Builder keyFile(String keyFile)

(experimental) (Optional) A path to a PEM-encoded private key, required if cert_file is specified.

Parameters:

keyFile - (Optional) A path to a PEM-encoded private key, required if cert_file is specified. This parameter is required.

Returns:

this

lock

@Stability(value=Experimental)
public ConsulBackend.Builder lock(Boolean lock)

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

Parameters:

lock - (Optional) false to disable locking. This parameter is required.

Returns:

this

scheme

@Stability(value=Experimental)
public ConsulBackend.Builder scheme(String scheme)

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

Parameters:

scheme - (Optional) Specifies what protocol to use when talking to the given address,either http or https. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public ConsulBackend build()

Specified by:

build in interface software.amazon.jsii.Builder<ConsulBackend>