Skip to main content

​
Initializer 

import io.cdktn.cdktn.DataTerraformRemoteStateConsulConfig;

DataTerraformRemoteStateConsulConfig.builder()
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .accessToken(java.lang.String)
    .path(java.lang.String)
//  .address(java.lang.String)
//  .caFile(java.lang.String)
//  .certFile(java.lang.String)
//  .datacenter(java.lang.String)
//  .gzip(java.lang.Boolean)
//  .httpAuth(java.lang.String)
//  .keyFile(java.lang.String)
//  .lock(java.lang.Boolean)
//  .scheme(java.lang.String)
    .build();

​
Properties

NameTypeDescription
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
accessTokenjava.lang.String(Required) Access token.
pathjava.lang.String(Required) Path in the Consul KV store.
addressjava.lang.String(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
caFilejava.lang.String(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.
certFilejava.lang.String(Optional) A path to a PEM-encoded certificate provided to the remote agent;
datacenterjava.lang.String(Optional) The datacenter to use.
gzipjava.lang.Boolean(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
httpAuthjava.lang.String(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
keyFilejava.lang.String(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
lockjava.lang.Boolean(Optional) false to disable locking.
schemejava.lang.String(Optional) Specifies what protocol to use when talking to the given address,either http or https.

​
defaultsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getDefaults();
  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional 

public java.lang.String getWorkspace();
  • Type: java.lang.String

​
accessTokenRequired 

public java.lang.String getAccessToken();
  • Type: java.lang.String
(Required) Access token.

​
pathRequired 

public java.lang.String getPath();
  • Type: java.lang.String
(Required) Path in the Consul KV store.

​
addressOptional 

public java.lang.String getAddress();
  • Type: java.lang.String
(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. Defaults to the local agent HTTP listener.

​
caFileOptional 

public java.lang.String getCaFile();
  • Type: java.lang.String
(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.

​
certFileOptional 

public java.lang.String getCertFile();
  • Type: java.lang.String
(Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file.

​
datacenterOptional 

public java.lang.String getDatacenter();
  • Type: java.lang.String
(Optional) The datacenter to use. Defaults to that of the agent.

​
gzipOptional 

public java.lang.Boolean getGzip();
  • Type: java.lang.Boolean
(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

​
httpAuthOptional 

public java.lang.String getHttpAuth();
  • Type: java.lang.String
(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

​
keyFileOptional 

public java.lang.String getKeyFile();
  • Type: java.lang.String
(Optional) A path to a PEM-encoded private key, required if cert_file is specified.

​
lockOptional 

public java.lang.Boolean getLock();
  • Type: java.lang.Boolean
(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.

​
schemeOptional 

public java.lang.String getScheme();
  • Type: java.lang.String
(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.