com.hashicorp.cdktf

Class ConsulBackendConfig.Builder

java.lang.Object

com.hashicorp.cdktf.ConsulBackendConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ConsulBackendConfig>

Enclosing interface:

ConsulBackendConfig

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

A builder for ConsulBackendConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ConsulBackendConfig.Builder	accessToken(String accessToken) Sets the value of ConsulBackendConfig.getAccessToken()
ConsulBackendConfig.Builder	address(String address) Sets the value of ConsulBackendConfig.getAddress()
ConsulBackendConfig	build() Builds the configured instance.
ConsulBackendConfig.Builder	caFile(String caFile) Sets the value of ConsulBackendConfig.getCaFile()
ConsulBackendConfig.Builder	certFile(String certFile) Sets the value of ConsulBackendConfig.getCertFile()
ConsulBackendConfig.Builder	datacenter(String datacenter) Sets the value of ConsulBackendConfig.getDatacenter()
ConsulBackendConfig.Builder	gzip(Boolean gzip) Sets the value of ConsulBackendConfig.getGzip()
ConsulBackendConfig.Builder	httpAuth(String httpAuth) Sets the value of ConsulBackendConfig.getHttpAuth()
ConsulBackendConfig.Builder	keyFile(String keyFile) Sets the value of ConsulBackendConfig.getKeyFile()
ConsulBackendConfig.Builder	lock(Boolean lock) Sets the value of ConsulBackendConfig.getLock()
ConsulBackendConfig.Builder	path(String path) Sets the value of ConsulBackendConfig.getPath()
ConsulBackendConfig.Builder	scheme(String scheme) Sets the value of ConsulBackendConfig.getScheme()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

accessToken

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

Sets the value of ConsulBackendConfig.getAccessToken()

Parameters:

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

Returns:

this

path

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

Sets the value of ConsulBackendConfig.getPath()

Parameters:

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

Returns:

this

address

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

Sets the value of ConsulBackendConfig.getAddress()

Parameters:

address - (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. Defaults to the local agent HTTP listener.

Returns:

this

caFile

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

Sets the value of ConsulBackendConfig.getCaFile()

Parameters:

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

Returns:

this

certFile

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

Sets the value of ConsulBackendConfig.getCertFile()

Parameters:

certFile - (Optional) A path to a PEM-encoded certificate provided to the remote agent;. requires use of key_file.

Returns:

this

datacenter

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

Sets the value of ConsulBackendConfig.getDatacenter()

Parameters:

datacenter - (Optional) The datacenter to use. Defaults to that of the agent.

Returns:

this

gzip

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

Sets the value of ConsulBackendConfig.getGzip()

Parameters:

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

Returns:

this

httpAuth

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

Sets the value of ConsulBackendConfig.getHttpAuth()

Parameters:

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

Returns:

this

keyFile

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

Sets the value of ConsulBackendConfig.getKeyFile()

Parameters:

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

Returns:

this

lock

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

Sets the value of ConsulBackendConfig.getLock()

Parameters:

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

Returns:

this

scheme

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

Sets the value of ConsulBackendConfig.getScheme()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ConsulBackendConfig

Throws:

NullPointerException - if any required attribute was not provided