Package com.hashicorp.cdktf
@Stability(Experimental)
package com.hashicorp.cdktf
cdktf
cdktf is a framework for defining cloud infrastructure using Terraform providers and modules. It allows for users to define infrastructure resources using higher-level programming languages.
Build
Install dependencies
yarn install
Build the package
yarn build
-
ClassDescription(experimental) Includes API for attaching annotations such as warning messages to constructs.(experimental) Represents a cdktf application.(experimental) A fluent builder for
App.A builder forAppConfigAn implementation forAppConfig(experimental) Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.(experimental) A fluent builder forAzurermBackend.(experimental) Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account.A builder forAzurermBackendConfigAn implementation forAzurermBackendConfig(experimental) The Cloud Backend synthesizes acloud block}.invalid @link
{@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block(experimental) A fluent builder forCloudBackend.(experimental) The Cloud Backend synthesizes acloud block}.invalid @link
{@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-blockA builder forCloudBackendConfigAn implementation forCloudBackendConfig(experimental) A cloud workspace can either be a single named workspace, or a list of tagged workspaces.Deprecated.Going to be replaced by Array of ComplexListItem and will be removed in the future(experimental) A fluent builder forConsulBackend.(experimental) Stores the state in the Consul KV store at a given path.A builder forConsulBackendConfigAn implementation forConsulBackendConfig(experimental) A fluent builder forCosBackend.A builder forCosBackendAssumeRoleAn implementation forCosBackendAssumeRole(experimental) Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS).A builder forCosBackendConfigAn implementation forCosBackendConfigA builder forDataConfigAn implementation forDataConfig(experimental) The DataResource implements the standard resource lifecycle, but does not directly take any other actions.(experimental) A fluent builder forDataResource.(experimental) A fluent builder forDataTerraformRemoteState.(experimental) A fluent builder forDataTerraformRemoteStateAzurerm.A builder forDataTerraformRemoteStateAzurermConfigAn implementation forDataTerraformRemoteStateAzurermConfigA builder forDataTerraformRemoteStateConfigAn implementation forDataTerraformRemoteStateConfig(experimental) A fluent builder forDataTerraformRemoteStateConsul.A builder forDataTerraformRemoteStateConsulConfigAn implementation forDataTerraformRemoteStateConsulConfig(experimental) A fluent builder forDataTerraformRemoteStateCos.A builder forDataTerraformRemoteStateCosConfigAn implementation forDataTerraformRemoteStateCosConfig(experimental) A fluent builder forDataTerraformRemoteStateGcs.A builder forDataTerraformRemoteStateGcsConfigAn implementation forDataTerraformRemoteStateGcsConfig(experimental) A fluent builder forDataTerraformRemoteStateHttp.A builder forDataTerraformRemoteStateHttpConfigAn implementation forDataTerraformRemoteStateHttpConfig(experimental) A fluent builder forDataTerraformRemoteStateLocal.A builder forDataTerraformRemoteStateLocalConfigAn implementation forDataTerraformRemoteStateLocalConfig(experimental) A fluent builder forDataTerraformRemoteStateOss.A builder forDataTerraformRemoteStateOssConfigAn implementation forDataTerraformRemoteStateOssConfig(experimental) A fluent builder forDataTerraformRemoteStatePg.A builder forDataTerraformRemoteStatePgConfigAn implementation forDataTerraformRemoteStatePgConfigA builder forDataTerraformRemoteStateRemoteConfigAn implementation forDataTerraformRemoteStateRemoteConfig(experimental) A fluent builder forDataTerraformRemoteStateS3.A builder forDataTerraformRemoteStateS3ConfigAn implementation forDataTerraformRemoteStateS3ConfigDeprecated.CDK for Terraform no longer supports the swift backend.Deprecated.Deprecated.CDK for Terraform no longer supports the swift backend.Deprecated.Deprecated.(experimental) Default resolver implementation.(experimental) Properties to string encodings.A builder forEncodingOptionsAn implementation forEncodingOptions(experimental) The file provisioner copies files or directories from the machine running Terraform to the newly created resource.A builder forFileProvisionerAn implementation forFileProvisioner(experimental) A fluent builder forGcsBackend.(experimental) Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS).A builder forGcsBackendConfigAn implementation forGcsBackendConfig(experimental) A fluent builder forHttpBackend.(experimental) Stores the state using a simple REST client.A builder forHttpBackendConfigAn implementation forHttpBackendConfig(experimental) Interface for lazy untyped value producers.Internal default implementation forIAnyProducer.A proxy class which represents a concrete javascript instance of this type.(experimental) Represents an Aspect.Internal default implementation forIAspect.A proxy class which represents a concrete javascript instance of this type.(experimental) Function used to concatenate symbols in the target document language.Internal default implementation forIFragmentConcatenator.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIImportableConfig.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIInterpolatingParent.A proxy class which represents a concrete javascript instance of this type.(experimental) Interface for lazy list producers.Internal default implementation forIListProducer.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIManifest.A proxy class which represents a concrete javascript instance of this type.(experimental) Class used to represent an importable resource.(experimental) Interface for lazy number producers.Internal default implementation forINumberProducer.A proxy class which represents a concrete javascript instance of this type.(experimental) A Token that can post-process the complete resolved value, after resolve() has recursed over it.Internal default implementation forIPostProcessor.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIRemoteWorkspace.A proxy class which represents a concrete javascript instance of this type.(experimental) Interface for values that can be resolvable later.Internal default implementation forIResolvable.A proxy class which represents a concrete javascript instance of this type.(experimental) Current resolution context for tokens.Internal default implementation forIResolveContext.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIResource.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIResourceConstructor.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIScopeCallback.A proxy class which represents a concrete javascript instance of this type.(experimental) Encodes information how a certain Stack should be deployed inspired by AWS CDK v2 implementation (synth functionality was removed in constructs v10).Internal default implementation forIStackSynthesizer.A proxy class which represents a concrete javascript instance of this type.(experimental) Interface for lazy string producers.Internal default implementation forIStringProducer.A proxy class which represents a concrete javascript instance of this type.(experimental) Represents a single session of synthesis.Internal default implementation forISynthesisSession.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forITerraformAddressable.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forITerraformDependable.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forITerraformIterator.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forITerraformResource.A proxy class which represents a concrete javascript instance of this type.(experimental) Interface to apply operation to tokens in a string.Internal default implementation forITokenMapper.A proxy class which represents a concrete javascript instance of this type.(experimental) How to resolve tokens.Internal default implementation forITokenResolver.A proxy class which represents a concrete javascript instance of this type.(experimental) Lazily produce a value.(experimental) Options for creating lazy untyped tokens.A builder forLazyAnyValueOptionsAn implementation forLazyAnyValueOptions(experimental) Options for creating a lazy list token.A builder forLazyListValueOptionsAn implementation forLazyListValueOptions(experimental) Options for creating a lazy string token.A builder forLazyStringValueOptionsAn implementation forLazyStringValueOptions(experimental) A fluent builder forLocalBackend.(experimental) The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally.A builder forLocalBackendConfigAn implementation forLocalBackendConfig(experimental) The local-exec provisioner invokes a local executable after a resource is created.A builder forLocalExecProvisionerAn implementation forLocalExecProvisioner(experimental) For migrating past 0.17 where the feature flag for the old id generation logic was removed after being deprecated since 0.15.(experimental) The name of a single Terraform Cloud workspace.(experimental) This class contains static functions for all arithmetical and logical operators in the Terraform configuration language.A builder forOssAssumeRoleAn implementation forOssAssumeRole(experimental) A fluent builder forOssBackend.A builder forOssBackendConfigAn implementation forOssBackendConfig(experimental) A fluent builder forPgBackend.A builder forPgBackendConfigAn implementation forPgBackendConfig(experimental) Terraform checks a postcondition after evaluating the object it is associated with.A builder forPostconditionAn implementation forPostcondition(experimental) Terraform checks a precondition before evaluating the object it is associated with.A builder forPreconditionAn implementation forPrecondition(experimental) A fluent builder forRemoteBackend.A builder forRemoteBackendConfigAn implementation forRemoteBackendConfig(experimental) The remote-exec provisioner invokes a script on a remote resource after it is created.A builder forRemoteExecProvisionerAn implementation forRemoteExecProvisioner(experimental) Options to the resolve() operation.A builder forResolveOptionsAn implementation forResolveOptionsDeprecated.Please use Construct from the constructs package instead.(experimental) A fluent builder forS3Backend.A builder forS3BackendAssumeRoleConfigAn implementation forS3BackendAssumeRoleConfigA builder forS3BackendAssumeRoleWithWebIdentityConfigAn implementation forS3BackendAssumeRoleWithWebIdentityConfig(experimental) Stores the state as a given key in a given bucket on Amazon S3.A builder forS3BackendConfigAn implementation forS3BackendConfigA builder forS3BackendEndpointConfigAn implementation forS3BackendEndpointConfig(experimental) Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.A builder forSSHProvisionerConnectionAn implementation forSSHProvisionerConnectionA builder forStackAnnotationAn implementation forStackAnnotationA builder forStackManifestAn implementation forStackManifest(experimental) Converts all fragments to strings and concats those.Deprecated.CDK for Terraform no longer supports the swift backend.Deprecated.Deprecated.CDK for Terraform no longer supports the swift backend.Deprecated.Deprecated.(experimental) A set of Terraform Cloud workspace tags.(experimental) A fluent builder forTerraformAsset.A builder forTerraformAssetConfigAn implementation forTerraformAssetConfigA builder forTerraformConditionAn implementation forTerraformCondition(experimental) Iterator for the Terraform count property.(experimental) A fluent builder forTerraformDataSource.A builder forTerraformElementMetadataAn implementation forTerraformElementMetadata(experimental) A fluent builder forTerraformHclModule.A builder forTerraformHclModuleConfigAn implementation forTerraformHclModuleConfigA builder forTerraformMetaArgumentsAn implementation forTerraformMetaArgumentsA builder forTerraformModuleConfigAn implementation forTerraformModuleConfigA builder forTerraformModuleProviderAn implementation forTerraformModuleProviderA builder forTerraformModuleUserConfigAn implementation forTerraformModuleUserConfig(experimental) A fluent builder forTerraformOutput.A builder forTerraformOutputConfigAn implementation forTerraformOutputConfigA builder forTerraformProviderConfigAn implementation forTerraformProviderConfigA builder forTerraformProviderGeneratorMetadataAn implementation forTerraformProviderGeneratorMetadata(experimental) A fluent builder forTerraformResource.A builder forTerraformResourceConfigAn implementation forTerraformResourceConfigA builder forTerraformResourceImportAn implementation forTerraformResourceImportA builder forTerraformResourceLifecycleAn implementation forTerraformResourceLifecycleA builder forTerraformResourceMoveByIdAn implementation forTerraformResourceMoveByIdA builder forTerraformResourceMoveByTargetAn implementation forTerraformResourceMoveByTarget(experimental) Expressions in connection blocks cannot refer to their parent resource by name.A builder forTerraformStackMetadataAn implementation forTerraformStackMetadata(experimental) A fluent builder forTerraformVariable.A builder forTerraformVariableConfigAn implementation forTerraformVariableConfig(experimental) Add one or more validation blocks within the variable block to specify custom conditions.A builder forTerraformVariableValidationConfigAn implementation forTerraformVariableValidationConfig(experimental) Testing utilities for cdktf applications.A builder forTestingAppConfigAn implementation forTestingAppConfig(experimental) Represents a special or lazily-evaluated value.(experimental) Less oft-needed functions to manipulate Tokens.(experimental) Fragments of a concatenated string containing stringified Tokens.(experimental) Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.A builder forWinrmProvisionerConnectionAn implementation forWinrmProvisionerConnection