Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Initializers 

import io.cdktn.cdktn.ConsulBackend;

ConsulBackend.Builder.create(Construct scope)
    .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();
NameTypeDescription
scopesoftware.constructs.ConstructNo 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.

​
scopeRequired

  • Type: software.constructs.Construct

​
accessTokenRequired

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

​
pathRequired

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

​
addressOptional

  • 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

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

​
certFileOptional

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

​
datacenterOptional

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

​
gzipOptional

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

​
httpAuthOptional

  • 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

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

​
lockOptional

  • 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

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

​
Methods

NameDescription
toStringReturns a string representation of this construct.
addOverrideNo description.
overrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraformNo description.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getRemoteStateDataSourceCreates a TerraformRemoteState resource that accesses this backend.

​
toString 

public java.lang.String toString()
Returns a string representation of this construct.

​
addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

​
pathRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: java.lang.String
The new logical ID to use for this stack element.

​
resetOverrideLogicalId 

public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.

​
toHclTerraform 

public java.lang.Object toHclTerraform()

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.

​
getRemoteStateDataSource 

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)
Creates a TerraformRemoteState resource that accesses this backend.

​
scopeRequired

  • Type: software.constructs.Construct

​
nameRequired

  • Type: java.lang.String

​
_fromStackRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.
isBackendNo description.

​
isConstruct 

import io.cdktn.cdktn.ConsulBackend;

ConsulBackend.isConstruct(java.lang.Object x)
Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

​
xRequired

  • Type: java.lang.Object
Any object.

​
isTerraformElement 

import io.cdktn.cdktn.ConsulBackend;

ConsulBackend.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
isBackend 

import io.cdktn.cdktn.ConsulBackend;

ConsulBackend.isBackend(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnjava.lang.StringNo description.
friendlyUniqueIdjava.lang.StringNo description.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
cdktfStackRequired 

public TerraformStack getCdktfStack();

​
fqnRequired 

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

​
friendlyUniqueIdRequired 

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