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.DataTerraformRemoteStateHttp;

DataTerraformRemoteStateHttp.Builder.create(Construct scope, java.lang.String id)
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .address(java.lang.String)
//  .clientCaCertificatePem(java.lang.String)
//  .clientCertificatePem(java.lang.String)
//  .clientPrivateKeyPem(java.lang.String)
//  .lockAddress(java.lang.String)
//  .lockMethod(java.lang.String)
//  .password(java.lang.String)
//  .retryMax(java.lang.Number)
//  .retryWaitMax(java.lang.Number)
//  .retryWaitMin(java.lang.Number)
//  .skipCertVerification(java.lang.Boolean)
//  .unlockAddress(java.lang.String)
//  .unlockMethod(java.lang.String)
//  .updateMethod(java.lang.String)
//  .username(java.lang.String)
    .build();
NameTypeDescription
scopesoftware.constructs.ConstructNo description.
idjava.lang.StringNo description.
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
addressjava.lang.String(Required) The address of the REST endpoint.
clientCaCertificatePemjava.lang.String(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePemjava.lang.String(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPemjava.lang.String(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddressjava.lang.String(Optional) The address of the lock REST endpoint.
lockMethodjava.lang.String(Optional) The HTTP method to use when locking.
passwordjava.lang.String(Optional) The password for HTTP basic authentication.
retryMaxjava.lang.Number(Optional) The number of HTTP request retries.
retryWaitMaxjava.lang.Number(Optional) The maximum time in seconds to wait between HTTP request attempts.
retryWaitMinjava.lang.Number(Optional) The minimum time in seconds to wait between HTTP request attempts.
skipCertVerificationjava.lang.Boolean(Optional) Whether to skip TLS verification.
unlockAddressjava.lang.String(Optional) The address of the unlock REST endpoint.
unlockMethodjava.lang.String(Optional) The HTTP method to use when unlocking.
updateMethodjava.lang.String(Optional) HTTP method to use when updating state.
usernamejava.lang.String(Optional) The username for HTTP basic authentication.

​
scopeRequired

  • Type: software.constructs.Construct

​
idRequired

  • Type: java.lang.String

​
defaultsOptional

  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional

  • Type: java.lang.String

​
addressRequired

  • Type: java.lang.String
(Required) The address of the REST endpoint.

​
clientCaCertificatePemOptional

  • Type: java.lang.String
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

​
clientCertificatePemOptional

  • Type: java.lang.String
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

​
clientPrivateKeyPemOptional

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

​
lockAddressOptional

  • Type: java.lang.String
(Optional) The address of the lock REST endpoint. Defaults to disabled.

​
lockMethodOptional

  • Type: java.lang.String
(Optional) The HTTP method to use when locking. Defaults to LOCK.

​
passwordOptional

  • Type: java.lang.String
(Optional) The password for HTTP basic authentication.

​
retryMaxOptional

  • Type: java.lang.Number
(Optional) The number of HTTP request retries. Defaults to 2.

​
retryWaitMaxOptional

  • Type: java.lang.Number
(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

​
retryWaitMinOptional

  • Type: java.lang.Number
(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

​
skipCertVerificationOptional

  • Type: java.lang.Boolean
(Optional) Whether to skip TLS verification. Defaults to false.

​
unlockAddressOptional

  • Type: java.lang.String
(Optional) The address of the unlock REST endpoint. Defaults to disabled.

​
unlockMethodOptional

  • Type: java.lang.String
(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

​
updateMethodOptional

  • Type: java.lang.String
(Optional) HTTP method to use when updating state. Defaults to POST.

​
usernameOptional

  • Type: java.lang.String
(Optional) The username for HTTP basic authentication.

​
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.
toHclTerraformAdds this resource to the terraform JSON output.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getNo description.
getBooleanNo description.
getListNo description.
getNumberNo description.
getStringNo description.

​
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()
Adds this resource to the terraform JSON output.

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

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

​
get 

public IResolvable get(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getBoolean 

public IResolvable getBoolean(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getList 

public java.util.List<java.lang.String> getList(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getNumber 

public java.lang.Number getNumber(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getString 

public java.lang.String getString(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.

​
isConstruct 

import io.cdktn.cdktn.DataTerraformRemoteStateHttp;

DataTerraformRemoteStateHttp.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.DataTerraformRemoteStateHttp;

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

​
Constants

NameTypeDescription
tfResourceTypejava.lang.StringNo description.

​
tfResourceTypeRequired 

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