Interface Summary
Interface	Description
AppOptions
ArtifactoryBackendProps
AzurermBackendProps
ConsulBackendProps
CosBackendProps
DataTerraformRemoteStateArtifactoryConfig
DataTerraformRemoteStateAzurermConfig
DataTerraformRemoteStateConfig
DataTerraformRemoteStateConsulConfig
DataTerraformRemoteStateCosConfig
DataTerraformRemoteStateEtcdConfig
DataTerraformRemoteStateEtcdV3Config
DataTerraformRemoteStateGcsConfig
DataTerraformRemoteStateHttpConfig
DataTerraformRemoteStateLocalConfig
DataTerraformRemoteStateMantaConfig
DataTerraformRemoteStateOssConfig
DataTerraformRemoteStatePgConfig
DataTerraformRemoteStateRemoteConfig
DataTerraformRemoteStateS3Config
DataTerraformRemoteStateSwiftConfig
EncodingOptions	(experimental) Properties to string encodings.
EtcdBackendProps
EtcdV3BackendProps
GcsBackendProps
HttpBackendProps
IAnyProducer	(experimental) Interface for lazy untyped value producers.
IAnyProducer.Jsii$Default	Internal default implementation for `IAnyProducer`.
IAspect	(experimental) Represents an Aspect.
IAspect.Jsii$Default	Internal default implementation for `IAspect`.
IFragmentConcatenator	(experimental) Function used to concatenate symbols in the target document language.
IFragmentConcatenator.Jsii$Default	Internal default implementation for `IFragmentConcatenator`.
IListProducer	(experimental) Interface for lazy list producers.
IListProducer.Jsii$Default	Internal default implementation for `IListProducer`.
IManifest
IManifest.Jsii$Default	Internal default implementation for `IManifest`.
INumberProducer	(experimental) Interface for lazy number producers.
INumberProducer.Jsii$Default	Internal default implementation for `INumberProducer`.
IPostProcessor	(experimental) A Token that can post-process the complete resolved value, after resolve() has recursed over it.
IPostProcessor.Jsii$Default	Internal default implementation for `IPostProcessor`.
IRemoteWorkspace
IRemoteWorkspace.Jsii$Default	Internal default implementation for `IRemoteWorkspace`.
IResolvable	(experimental) Interface for values that can be resolvable later.
IResolvable.Jsii$Default	Internal default implementation for `IResolvable`.
IResolveContext	(experimental) Current resolution context for tokens.
IResolveContext.Jsii$Default	Internal default implementation for `IResolveContext`.
IResource
IResource.Jsii$Default	Internal default implementation for `IResource`.
IResourceConstructor
IResourceConstructor.Jsii$Default	Internal default implementation for `IResourceConstructor`.
IScopeCallback
IScopeCallback.Jsii$Default	Internal default implementation for `IScopeCallback`.
IStackSynthesizer	(experimental) Encodes information how a certain Stack should be deployed inspired by AWS CDK v2 implementation (synth functionality was removed in constructs v10).
IStackSynthesizer.Jsii$Default	Internal default implementation for `IStackSynthesizer`.
IStringProducer	(experimental) Interface for lazy string producers.
IStringProducer.Jsii$Default	Internal default implementation for `IStringProducer`.
ISynthesisSession	(experimental) Represents a single session of synthesis.
ISynthesisSession.Jsii$Default	Internal default implementation for `ISynthesisSession`.
ITerraformDependable
ITerraformDependable.Jsii$Default	Internal default implementation for `ITerraformDependable`.
ITerraformResource
ITerraformResource.Jsii$Default	Internal default implementation for `ITerraformResource`.
ITokenMapper	(experimental) Interface to apply operation to tokens in a string.
ITokenMapper.Jsii$Default	Internal default implementation for `ITokenMapper`.
ITokenResolver	(experimental) How to resolve tokens.
ITokenResolver.Jsii$Default	Internal default implementation for `ITokenResolver`.
LazyAnyValueOptions	(experimental) Options for creating lazy untyped tokens.
LazyListValueOptions	(experimental) Options for creating a lazy list token.
LazyStringValueOptions	(experimental) Options for creating a lazy string token.
LocalBackendProps
MantaBackendProps
OssAssumeRole
OssBackendProps
PgBackendProps
RemoteBackendProps
ResolveOptions	(experimental) Options to the resolve() operation.
S3BackendProps
StackAnnotation
StackManifest
SwiftBackendProps
TerraformAssetConfig
TerraformElementMetadata
TerraformHclModuleOptions
TerraformMetaArguments
TerraformModuleOptions
TerraformModuleProvider
TerraformOutputConfig
TerraformProviderConfig
TerraformProviderGeneratorMetadata
TerraformResourceConfig
TerraformResourceLifecycle
TerraformStackMetadata
TerraformVariableConfig

Class Summary
Class	Description
Annotations	(experimental) Includes API for attaching annotations such as warning messages to constructs.
App	(experimental) Represents a cdktf application.
App.Builder	(experimental) A fluent builder for `App`.
AppOptions.Builder	A builder for `AppOptions`
AppOptions.Jsii$Proxy	An implementation for `AppOptions`
ArtifactoryBackend
ArtifactoryBackend.Builder	(experimental) A fluent builder for `ArtifactoryBackend`.
ArtifactoryBackendProps.Builder	A builder for `ArtifactoryBackendProps`
ArtifactoryBackendProps.Jsii$Proxy	An implementation for `ArtifactoryBackendProps`
Aspects	(experimental) Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.
AzurermBackend
AzurermBackend.Builder	(experimental) A fluent builder for `AzurermBackend`.
AzurermBackendProps.Builder	A builder for `AzurermBackendProps`
AzurermBackendProps.Jsii$Proxy	An implementation for `AzurermBackendProps`
BooleanMap
ComplexComputedList
ComplexObject
ConsulBackend
ConsulBackend.Builder	(experimental) A fluent builder for `ConsulBackend`.
ConsulBackendProps.Builder	A builder for `ConsulBackendProps`
ConsulBackendProps.Jsii$Proxy	An implementation for `ConsulBackendProps`
CosBackend
CosBackend.Builder	(experimental) A fluent builder for `CosBackend`.
CosBackendProps.Builder	A builder for `CosBackendProps`
CosBackendProps.Jsii$Proxy	An implementation for `CosBackendProps`
DataTerraformRemoteState
DataTerraformRemoteState.Builder	(experimental) A fluent builder for `DataTerraformRemoteState`.
DataTerraformRemoteStateArtifactory
DataTerraformRemoteStateArtifactory.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateArtifactory`.
DataTerraformRemoteStateArtifactoryConfig.Builder	A builder for `DataTerraformRemoteStateArtifactoryConfig`
DataTerraformRemoteStateArtifactoryConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateArtifactoryConfig`
DataTerraformRemoteStateAzurerm
DataTerraformRemoteStateAzurerm.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateAzurerm`.
DataTerraformRemoteStateAzurermConfig.Builder	A builder for `DataTerraformRemoteStateAzurermConfig`
DataTerraformRemoteStateAzurermConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateAzurermConfig`
DataTerraformRemoteStateConfig.Builder	A builder for `DataTerraformRemoteStateConfig`
DataTerraformRemoteStateConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateConfig`
DataTerraformRemoteStateConsul
DataTerraformRemoteStateConsul.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateConsul`.
DataTerraformRemoteStateConsulConfig.Builder	A builder for `DataTerraformRemoteStateConsulConfig`
DataTerraformRemoteStateConsulConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateConsulConfig`
DataTerraformRemoteStateCos
DataTerraformRemoteStateCos.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateCos`.
DataTerraformRemoteStateCosConfig.Builder	A builder for `DataTerraformRemoteStateCosConfig`
DataTerraformRemoteStateCosConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateCosConfig`
DataTerraformRemoteStateEtcd
DataTerraformRemoteStateEtcd.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateEtcd`.
DataTerraformRemoteStateEtcdConfig.Builder	A builder for `DataTerraformRemoteStateEtcdConfig`
DataTerraformRemoteStateEtcdConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateEtcdConfig`
DataTerraformRemoteStateEtcdV3
DataTerraformRemoteStateEtcdV3.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateEtcdV3`.
DataTerraformRemoteStateEtcdV3Config.Builder	A builder for `DataTerraformRemoteStateEtcdV3Config`
DataTerraformRemoteStateEtcdV3Config.Jsii$Proxy	An implementation for `DataTerraformRemoteStateEtcdV3Config`
DataTerraformRemoteStateGcs
DataTerraformRemoteStateGcs.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateGcs`.
DataTerraformRemoteStateGcsConfig.Builder	A builder for `DataTerraformRemoteStateGcsConfig`
DataTerraformRemoteStateGcsConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateGcsConfig`
DataTerraformRemoteStateHttp
DataTerraformRemoteStateHttp.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateHttp`.
DataTerraformRemoteStateHttpConfig.Builder	A builder for `DataTerraformRemoteStateHttpConfig`
DataTerraformRemoteStateHttpConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateHttpConfig`
DataTerraformRemoteStateLocal
DataTerraformRemoteStateLocal.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateLocal`.
DataTerraformRemoteStateLocalConfig.Builder	A builder for `DataTerraformRemoteStateLocalConfig`
DataTerraformRemoteStateLocalConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateLocalConfig`
DataTerraformRemoteStateManta
DataTerraformRemoteStateManta.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateManta`.
DataTerraformRemoteStateMantaConfig.Builder	A builder for `DataTerraformRemoteStateMantaConfig`
DataTerraformRemoteStateMantaConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateMantaConfig`
DataTerraformRemoteStateOss
DataTerraformRemoteStateOss.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateOss`.
DataTerraformRemoteStateOssConfig.Builder	A builder for `DataTerraformRemoteStateOssConfig`
DataTerraformRemoteStateOssConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateOssConfig`
DataTerraformRemoteStatePg
DataTerraformRemoteStatePg.Builder	(experimental) A fluent builder for `DataTerraformRemoteStatePg`.
DataTerraformRemoteStatePgConfig.Builder	A builder for `DataTerraformRemoteStatePgConfig`
DataTerraformRemoteStatePgConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStatePgConfig`
DataTerraformRemoteStateRemoteConfig.Builder	A builder for `DataTerraformRemoteStateRemoteConfig`
DataTerraformRemoteStateRemoteConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateRemoteConfig`
DataTerraformRemoteStateS3
DataTerraformRemoteStateS3.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateS3`.
DataTerraformRemoteStateS3Config.Builder	A builder for `DataTerraformRemoteStateS3Config`
DataTerraformRemoteStateS3Config.Jsii$Proxy	An implementation for `DataTerraformRemoteStateS3Config`
DataTerraformRemoteStateSwift
DataTerraformRemoteStateSwift.Builder	(experimental) A fluent builder for `DataTerraformRemoteStateSwift`.
DataTerraformRemoteStateSwiftConfig.Builder	A builder for `DataTerraformRemoteStateSwiftConfig`
DataTerraformRemoteStateSwiftConfig.Jsii$Proxy	An implementation for `DataTerraformRemoteStateSwiftConfig`
DefaultTokenResolver	(experimental) Default resolver implementation.
EncodingOptions.Builder	A builder for `EncodingOptions`
EncodingOptions.Jsii$Proxy	An implementation for `EncodingOptions`
EtcdBackend
EtcdBackend.Builder	(experimental) A fluent builder for `EtcdBackend`.
EtcdBackendProps.Builder	A builder for `EtcdBackendProps`
EtcdBackendProps.Jsii$Proxy	An implementation for `EtcdBackendProps`
EtcdV3Backend
EtcdV3Backend.Builder	(experimental) A fluent builder for `EtcdV3Backend`.
EtcdV3BackendProps.Builder	A builder for `EtcdV3BackendProps`
EtcdV3BackendProps.Jsii$Proxy	An implementation for `EtcdV3BackendProps`
Fn
GcsBackend
GcsBackend.Builder	(experimental) A fluent builder for `GcsBackend`.
GcsBackendProps.Builder	A builder for `GcsBackendProps`
GcsBackendProps.Jsii$Proxy	An implementation for `GcsBackendProps`
HttpBackend
HttpBackend.Builder	(experimental) A fluent builder for `HttpBackend`.
HttpBackendProps.Builder	A builder for `HttpBackendProps`
HttpBackendProps.Jsii$Proxy	An implementation for `HttpBackendProps`
IAnyProducer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IAspect.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IFragmentConcatenator.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IListProducer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IManifest.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
INumberProducer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPostProcessor.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IRemoteWorkspace.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResolvable.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResolveContext.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResourceConstructor.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IScopeCallback.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IStackSynthesizer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IStringProducer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ISynthesisSession.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ITerraformDependable.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ITerraformResource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ITokenMapper.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ITokenResolver.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Lazy	(experimental) Lazily produce a value.
LazyAnyValueOptions.Builder	A builder for `LazyAnyValueOptions`
LazyAnyValueOptions.Jsii$Proxy	An implementation for `LazyAnyValueOptions`
LazyBase
LazyListValueOptions.Builder	A builder for `LazyListValueOptions`
LazyListValueOptions.Jsii$Proxy	An implementation for `LazyListValueOptions`
LazyStringValueOptions.Builder	A builder for `LazyStringValueOptions`
LazyStringValueOptions.Jsii$Proxy	An implementation for `LazyStringValueOptions`
LocalBackend
LocalBackend.Builder	(experimental) A fluent builder for `LocalBackend`.
LocalBackendProps.Builder	A builder for `LocalBackendProps`
LocalBackendProps.Jsii$Proxy	An implementation for `LocalBackendProps`
Manifest
MantaBackend
MantaBackend.Builder	(experimental) A fluent builder for `MantaBackend`.
MantaBackendProps.Builder	A builder for `MantaBackendProps`
MantaBackendProps.Jsii$Proxy	An implementation for `MantaBackendProps`
NamedRemoteWorkspace
NumberMap
OssAssumeRole.Builder	A builder for `OssAssumeRole`
OssAssumeRole.Jsii$Proxy	An implementation for `OssAssumeRole`
OssBackend
OssBackend.Builder	(experimental) A fluent builder for `OssBackend`.
OssBackendProps.Builder	A builder for `OssBackendProps`
OssBackendProps.Jsii$Proxy	An implementation for `OssBackendProps`
PgBackend
PgBackend.Builder	(experimental) A fluent builder for `PgBackend`.
PgBackendProps.Builder	A builder for `PgBackendProps`
PgBackendProps.Jsii$Proxy	An implementation for `PgBackendProps`
PrefixedRemoteWorkspaces
RemoteBackend
RemoteBackend.Builder	(experimental) A fluent builder for `RemoteBackend`.
RemoteBackendProps.Builder	A builder for `RemoteBackendProps`
RemoteBackendProps.Jsii$Proxy	An implementation for `RemoteBackendProps`
ResolveOptions.Builder	A builder for `ResolveOptions`
ResolveOptions.Jsii$Proxy	An implementation for `ResolveOptions`
Resource	(experimental) A construct which represents a resource.
S3Backend
S3Backend.Builder	(experimental) A fluent builder for `S3Backend`.
S3BackendProps.Builder	A builder for `S3BackendProps`
S3BackendProps.Jsii$Proxy	An implementation for `S3BackendProps`
StackAnnotation.Builder	A builder for `StackAnnotation`
StackAnnotation.Jsii$Proxy	An implementation for `StackAnnotation`
StackManifest.Builder	A builder for `StackManifest`
StackManifest.Jsii$Proxy	An implementation for `StackManifest`
StringConcat	(experimental) Converts all fragments to strings and concats those.
StringMap
SwiftBackend
SwiftBackend.Builder	(experimental) A fluent builder for `SwiftBackend`.
SwiftBackendProps.Builder	A builder for `SwiftBackendProps`
SwiftBackendProps.Jsii$Proxy	An implementation for `SwiftBackendProps`
TerraformAsset
TerraformAsset.Builder	(experimental) A fluent builder for `TerraformAsset`.
TerraformAssetConfig.Builder	A builder for `TerraformAssetConfig`
TerraformAssetConfig.Jsii$Proxy	An implementation for `TerraformAssetConfig`
TerraformBackend
TerraformDataSource
TerraformDataSource.Builder	(experimental) A fluent builder for `TerraformDataSource`.
TerraformElement
TerraformElementMetadata.Builder	A builder for `TerraformElementMetadata`
TerraformElementMetadata.Jsii$Proxy	An implementation for `TerraformElementMetadata`
TerraformHclModule
TerraformHclModule.Builder	(experimental) A fluent builder for `TerraformHclModule`.
TerraformHclModuleOptions.Builder	A builder for `TerraformHclModuleOptions`
TerraformHclModuleOptions.Jsii$Proxy	An implementation for `TerraformHclModuleOptions`
TerraformLocal
TerraformMetaArguments.Builder	A builder for `TerraformMetaArguments`
TerraformMetaArguments.Jsii$Proxy	An implementation for `TerraformMetaArguments`
TerraformModule
TerraformModuleOptions.Builder	A builder for `TerraformModuleOptions`
TerraformModuleOptions.Jsii$Proxy	An implementation for `TerraformModuleOptions`
TerraformModuleProvider.Builder	A builder for `TerraformModuleProvider`
TerraformModuleProvider.Jsii$Proxy	An implementation for `TerraformModuleProvider`
TerraformOutput
TerraformOutput.Builder	(experimental) A fluent builder for `TerraformOutput`.
TerraformOutputConfig.Builder	A builder for `TerraformOutputConfig`
TerraformOutputConfig.Jsii$Proxy	An implementation for `TerraformOutputConfig`
TerraformProvider
TerraformProviderConfig.Builder	A builder for `TerraformProviderConfig`
TerraformProviderConfig.Jsii$Proxy	An implementation for `TerraformProviderConfig`
TerraformProviderGeneratorMetadata.Builder	A builder for `TerraformProviderGeneratorMetadata`
TerraformProviderGeneratorMetadata.Jsii$Proxy	An implementation for `TerraformProviderGeneratorMetadata`
TerraformRemoteState
TerraformResource
TerraformResource.Builder	(experimental) A fluent builder for `TerraformResource`.
TerraformResourceConfig.Builder	A builder for `TerraformResourceConfig`
TerraformResourceConfig.Jsii$Proxy	An implementation for `TerraformResourceConfig`
TerraformResourceLifecycle.Builder	A builder for `TerraformResourceLifecycle`
TerraformResourceLifecycle.Jsii$Proxy	An implementation for `TerraformResourceLifecycle`
TerraformStack
TerraformStackMetadata.Builder	A builder for `TerraformStackMetadata`
TerraformStackMetadata.Jsii$Proxy	An implementation for `TerraformStackMetadata`
TerraformVariable
TerraformVariable.Builder	(experimental) A fluent builder for `TerraformVariable`.
TerraformVariableConfig.Builder	A builder for `TerraformVariableConfig`
TerraformVariableConfig.Jsii$Proxy	An implementation for `TerraformVariableConfig`
Testing	(experimental) Testing utilities for cdktf applications.
Token	(experimental) Represents a special or lazily-evaluated value.
Tokenization	(experimental) Less oft-needed functions to manipulate Tokens.
TokenizedStringFragments	(experimental) Fragments of a concatenated string containing stringified Tokens.
VariableType

Enum Summary
Enum Description

AnnotationMetadataEntryType

AssetType

Enum Summary
Enum	Description
AnnotationMetadataEntryType
AssetType

Package com.hashicorp.cdktf Description

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