Skip to main content

Initializers


scopeRequired

  • Type: software.constructs.Construct

idRequired

  • Type: java.lang.String

defaultsOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.util.Map< java.lang.String, java.lang.Object >

workspaceOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

containerRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

applicationCredentialIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

applicationCredentialNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

applicationCredentialSecretOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

archiveContainerOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

authUrlOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

cacertFileOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

certOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

cloudOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

defaultDomainOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

domainIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

domainNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

expireAfterOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

insecureOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.Boolean

keyOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

passwordOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

projectDomainIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

projectDomainNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

regionNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

stateNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

tenantIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

tenantNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

tokenOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

userDomainIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

userDomainNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

userIdOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

userNameOptional

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

Methods


toString

Returns a string representation of this construct.

with

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired

  • Type: software.constructs.IMixin…
The mixins to apply.

addOverride

pathRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

overrideLogicalId

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

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

Adds this resource to the terraform JSON output.

toMetadata

toTerraform

Adds this resource to the terraform JSON output.

get

outputRequired

  • Type: java.lang.String

getBoolean

outputRequired

  • Type: java.lang.String

getList

outputRequired

  • Type: java.lang.String

getNumber

outputRequired

  • Type: java.lang.String

getString

outputRequired

  • Type: java.lang.String

Static Functions


isConstruct

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

xRequired

  • Type: java.lang.Object

Properties


nodeRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: software.constructs.Node
The tree node.

cdktfStackRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.

fqnRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

friendlyUniqueIdRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String

Constants


tfResourceTypeRequired

  • Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
  • Type: java.lang.String