Package com.hashicorp.cdktf

Class DataTerraformRemoteStateConsulConfig.Builder

java.lang.Object

com.hashicorp.cdktf.DataTerraformRemoteStateConsulConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DataTerraformRemoteStateConsulConfig>

Enclosing interface:

DataTerraformRemoteStateConsulConfig

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

A builder for DataTerraformRemoteStateConsulConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataTerraformRemoteStateConsulConfig.Builder	accessToken(String accessToken)	Sets the value of ConsulBackendConfig.getAccessToken()
DataTerraformRemoteStateConsulConfig.Builder	address(String address)	Sets the value of ConsulBackendConfig.getAddress()
DataTerraformRemoteStateConsulConfig	build()	Builds the configured instance.
DataTerraformRemoteStateConsulConfig.Builder	caFile(String caFile)	Sets the value of ConsulBackendConfig.getCaFile()
DataTerraformRemoteStateConsulConfig.Builder	certFile(String certFile)	Sets the value of ConsulBackendConfig.getCertFile()
DataTerraformRemoteStateConsulConfig.Builder	datacenter(String datacenter)	Sets the value of ConsulBackendConfig.getDatacenter()
DataTerraformRemoteStateConsulConfig.Builder	defaults(Map<String,? extends Object> defaults)	Sets the value of DataTerraformRemoteStateConfig.getDefaults()
DataTerraformRemoteStateConsulConfig.Builder	gzip(Boolean gzip)	Sets the value of ConsulBackendConfig.getGzip()
DataTerraformRemoteStateConsulConfig.Builder	httpAuth(String httpAuth)	Sets the value of ConsulBackendConfig.getHttpAuth()
DataTerraformRemoteStateConsulConfig.Builder	keyFile(String keyFile)	Sets the value of ConsulBackendConfig.getKeyFile()
DataTerraformRemoteStateConsulConfig.Builder	lock(Boolean lock)	Sets the value of ConsulBackendConfig.getLock()
DataTerraformRemoteStateConsulConfig.Builder	path(String path)	Sets the value of ConsulBackendConfig.getPath()
DataTerraformRemoteStateConsulConfig.Builder	scheme(String scheme)	Sets the value of ConsulBackendConfig.getScheme()
DataTerraformRemoteStateConsulConfig.Builder	workspace(String workspace)	Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

defaults

@Stability(Experimental)
public DataTerraformRemoteStateConsulConfig.Builder defaults(Map<String,? extends Object> defaults)

Sets the value of DataTerraformRemoteStateConfig.getDefaults()

Parameters:

defaults - the value to be set.

Returns:

this

workspace

@Stability(Experimental)
public DataTerraformRemoteStateConsulConfig.Builder workspace(String workspace)

Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Parameters:

workspace - the value to be set.

Returns:

this

accessToken

@Stability(Experimental)
public DataTerraformRemoteStateConsulConfig.Builder accessToken(String accessToken)

Sets the value of ConsulBackendConfig.getAccessToken()

Parameters:

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

Returns:

this

path

@Stability(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig.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(Experimental)
public DataTerraformRemoteStateConsulConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DataTerraformRemoteStateConsulConfig

Throws:

NullPointerException - if any required attribute was not provided