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

TerraformOutput.Builder.create(Construct scope, java.lang.String id)
    .value(java.lang.Object)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .description(java.lang.String)
//  .precondition(Precondition)
//  .sensitive(java.lang.Boolean)
//  .staticId(java.lang.Boolean)
    .build();
NameTypeDescription
scopesoftware.constructs.ConstructNo description.
idjava.lang.StringNo description.
valuejava.lang.ObjectNo description.
dependsOnjava.util.List<ITerraformDependable>No description.
descriptionjava.lang.StringNo description.
preconditionPreconditionNo description.
sensitivejava.lang.BooleanNo description.
staticIdjava.lang.BooleanIf set to true the synthesized Terraform Output will be named after the id passed to the constructor instead of the default (TerraformOutput.friendlyUniqueId).

​
scopeRequired

  • Type: software.constructs.Construct

​
idRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
dependsOnOptional

​
descriptionOptional

  • Type: java.lang.String

​
preconditionOptional

​
sensitiveOptional

  • Type: java.lang.Boolean

​
staticIdOptional

  • Type: java.lang.Boolean
  • Default: false
If set to true the synthesized Terraform Output will be named after the id passed to the constructor instead of the default (TerraformOutput.friendlyUniqueId).

​
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.
toTerraformNo 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()

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()

​
Static Functions

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

​
isConstruct 

import io.cdktn.cdktn.TerraformOutput;

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

TerraformOutput.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
isTerraformOutput 

import io.cdktn.cdktn.TerraformOutput;

TerraformOutput.isTerraformOutput(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.
staticIdjava.lang.BooleanNo description.
valuejava.lang.ObjectNo description.
dependsOnjava.util.List<ITerraformDependable>No description.
descriptionjava.lang.StringNo description.
preconditionPreconditionNo description.
sensitivejava.lang.BooleanNo 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

​
staticIdRequired 

public java.lang.Boolean getStaticId();
  • Type: java.lang.Boolean

​
valueRequired 

public java.lang.Object getValue();
  • Type: java.lang.Object

​
dependsOnOptional 

public java.util.List<ITerraformDependable> getDependsOn();

​
descriptionOptional 

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

​
preconditionOptional 

public Precondition getPrecondition();

​
sensitiveOptional 

public java.lang.Boolean getSensitive();
  • Type: java.lang.Boolean